cloudaccount#

async idem_vra.exec.vra.iaas.cloudaccount.create_aws_cloud_account_async(hub, ctx, accessKeyId, secretAccessKey, regions, name, **kwargs)[source]#

Create a cloud account Create a cloud account in the current organization Performs POST /iaas/api/cloud-accounts-aws

Parameters:

accessKeyId (string) – (required in body) Aws Access key ID
secretAccessKey (string) – (required in body) Aws Secret Access Key
regions (array) – (required in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
validateOnly (string) – (optional in query) If provided, it only validates the credentials in the Cloud Account Specification, and cloud account will not be created.
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
description (string) – (optional in body) A human-friendly description.
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.create_azure_cloud_account_async(hub, ctx, regions, clientApplicationId, clientApplicationSecretKey, name, tenantId, subscriptionId, **kwargs)[source]#

Create a cloud account Create a cloud account in the current organization Performs POST /iaas/api/cloud-accounts-azure

Parameters:

regions (array) – (required in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
clientApplicationId (string) – (required in body) Azure Client Application ID
clientApplicationSecretKey (string) – (required in body) Azure Client Application Secret Key
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
tenantId (string) – (required in body) Azure Tenant ID
subscriptionId (string) – (required in body) Azure Subscribtion ID
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
validateOnly (string) – (optional in query) If provided, it only validates the credentials in the Cloud Account Specification, and cloud account will not be created.
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
description (string) – (optional in body) A human-friendly description.
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.create_cloud_account_async(hub, ctx, cloudAccountProperties, regions, cloudAccountType, privateKey, name, privateKeyId, **kwargs)[source]#

Create a cloud account Create a cloud account in the current organization Performs POST /iaas/api/cloud-accounts

Parameters:

cloudAccountProperties (object) – (required in body) Cloud Account specific properties supplied in as name value pairs
regions (array) – (required in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration. ‘regionInfos’ is a required parameter for AWS, AZURE, GCP, VSPHERE, VMC, VCF cloud account types.
cloudAccountType (string) – (required in body) Cloud account type
privateKey (string) – (required in body) Secret access key or password to be used to authenticate with the cloud account. In case of AAP pass a dummy value.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
privateKeyId (string) – (required in body) Access key id or username to be used to authenticate with the cloud account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
validateOnly (string) – (optional in query) If provided, it only validates the credentials in the Cloud Account Specification, and cloud account will not be created.
associatedCloudAccountIds (array) – (optional in body) Cloud accounts to associate with this cloud account
description (string) – (optional in body) A human-friendly description.
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
customProperties (object) – (optional in body) Additional custom properties that may be used to extend the Cloud Account. In case of AAP, provide environment property here.Example: “customProperties”: { “environment”: “aap” }
associatedMobilityCloudAccountIds (object) – (optional in body) Cloud Account IDs and directionalities create associations to other vSphere cloud accounts that can be used for workload mobility. ID refers to an associated cloud account, and directionality can be unidirectional or bidirectional. Only supported on vSphere cloud accounts.

async idem_vra.exec.vra.iaas.cloudaccount.create_gcp_cloud_account_async(hub, ctx, privateKey, regions, clientEmail, name, projectId, privateKeyId, **kwargs)[source]#

Create a cloud account Create a cloud account in the current organization Performs POST /iaas/api/cloud-accounts-gcp

Parameters:

privateKey (string) – (required in body) GCP Private key
regions (array) – (required in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
clientEmail (string) – (required in body) GCP Client email
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
projectId (string) – (required in body) GCP Project ID
privateKeyId (string) – (required in body) GCP Private key ID
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
validateOnly (string) – (optional in query) If provided, it only validates the credentials in the Cloud Account Specification, and cloud account will not be created.
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
description (string) – (optional in body) A human-friendly description.
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.create_nsx_t_cloud_account_async(hub, ctx, hostName, password, dcid, name, username, **kwargs)[source]#

Create a cloud account Create a cloud account in the current organization Performs POST /iaas/api/cloud-accounts-nsx-t

Parameters:

hostName (string) – (required in body) Host name for the NSX-T endpoint
password (string) – (required in body) Password for the user used to authenticate with the cloud Account
dcid (string) – (required in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in vRA on-prem release and hence the data collector Id is optional for vRA on-prem.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
username (string) – (required in body) Username to authenticate with the cloud account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
validateOnly (string) – (optional in query) If provided, it only validates the credentials in the Cloud Account Specification, and cloud account will not be created.
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting.
associatedCloudAccountIds (array) – (optional in body) vSphere cloud accounts associated with this NSX-T cloud account.
managerMode (boolean) – (optional in body) Create NSX-T cloud account in Manager (legacy) mode. When set to true, NSX-T cloud account in created in Manager mode. Mode cannot be changed after cloud account is created. Default value is false.
description (string) – (optional in body) A human-friendly description.
certificateInfo (Any) – (optional in body)
isGlobalManager (boolean) – (optional in body) Indicates whether this is an NSX-T Global Manager cloud account. NSX-T Global Manager can only be associated with NSX-T cloud accounts. Default value: false.
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.create_nsx_v_cloud_account_async(hub, ctx, hostName, password, dcid, name, username, **kwargs)[source]#

Create a cloud account Create a cloud account in the current organization Performs POST /iaas/api/cloud-accounts-nsx-v

Parameters:

hostName (string) – (required in body) Host name for the NSX-v endpoint
password (string) – (required in body) Password for the user used to authenticate with the cloud Account
dcid (string) – (required in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in vRA on-prem release and hence the data collector Id is optional for vRA on-prem.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
username (string) – (required in body) Username to authenticate with the cloud account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
validateOnly (string) – (optional in query) If provided, it only validates the credentials in the Cloud Account Specification, and cloud account will not be created.
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting.
associatedCloudAccountIds (array) – (optional in body) vSphere cloud account associated with this NSX-V cloud account. NSX-V cloud account can be associated with a single vSphere cloud account.
description (string) – (optional in body) A human-friendly description.
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.create_v_sphere_cloud_account_async(hub, ctx, hostName, regions, password, name, username, **kwargs)[source]#

Create a cloud account Create a cloud account in the current organization Performs POST /iaas/api/cloud-accounts-vsphere

Parameters:

hostName (string) – (required in body) Host name for the vSphere endpoint
regions (array) – (required in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
password (string) – (required in body) Password for the user used to authenticate with the cloud Account
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
username (string) – (required in body) Username to authenticate with the cloud account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
validateOnly (string) – (optional in query) If provided, it only validates the credentials in the Cloud Account Specification, and cloud account will not be created.
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting to vSphere
associatedCloudAccountIds (array) – (optional in body) NSX-V or NSX-T account to associate with this vSphere cloud account. vSphere cloud account can be a single NSX-V cloud account or a single NSX-T cloud account.
description (string) – (optional in body) A human-friendly description.
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
dcid (string) – (optional in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in vRA on-prem release.
associatedMobilityCloudAccountIds (object) – (optional in body) Cloud account IDs and directionalities create associations to other vSphere cloud accounts that can be used for workload mobility. ID refers to an associated cloud account, and directionality can be unidirectional or bidirectional.

async idem_vra.exec.vra.iaas.cloudaccount.create_vcf_cloud_account_async(hub, ctx, vcenterPassword, regions, nsxHostName, vcenterUsername, vcenterHostName, nsxUsername, workloadDomainName, nsxPassword, name, workloadDomainId, **kwargs)[source]#

Create a cloud account Create a cloud account in the current organization Performs POST /iaas/api/cloud-accounts-vcf

Parameters:

vcenterPassword (string) – (required in body) Password for the user used to authenticate with the vCenter in VCF cloud account
regions (array) – (required in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
nsxHostName (string) – (required in body) Host name for the NSX endpoint from the specified workload domain.
vcenterUsername (string) – (required in body) vCenter user name for the specified workload domain.The specified user requires CloudAdmin credentials. The user does not require CloudGlobalAdmin credentials.
vcenterHostName (string) – (required in body) Host name for the vSphere from the specified workload domain.
nsxUsername (string) – (required in body) User name for the NSX manager in the specified workload domain.
workloadDomainName (string) – (required in body) Name of the workload domain to add as VCF cloud account.
nsxPassword (string) – (required in body) Password for the user used to authenticate with the NSX-T manager in VCF cloud account
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
workloadDomainId (string) – (required in body) Id of the workload domain to add as VCF cloud account.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
validateOnly (string) – (optional in query) If provided, it only validates the credentials in the Cloud Account Specification, and cloud account will not be created.
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting to vSphere and NSX-T
description (string) – (optional in body) A human-friendly description.
sddcManagerId (string) – (optional in body) SDDC manager integration id
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account.Cloud account capability tags may enable different features.
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
nsxCertificate (string) – (optional in body) NSX Certificate
vcenterCertificate (string) – (optional in body) vCenter Certificate
dcId (string) – (optional in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in vRA on-prem release.

async idem_vra.exec.vra.iaas.cloudaccount.create_vmc_cloud_account_async(hub, ctx, hostName, regions, apiKey, nsxHostName, sddcId, password, dcId, name, username, **kwargs)[source]#

Create a cloud account Create a cloud account in the current organization Performs POST /iaas/api/cloud-accounts-vmc

Parameters:

hostName (string) – (required in body) Enter the IP address or FQDN of the vCenter Server in the specified SDDC. The cloud proxy belongs on this vCenter.
regions (array) – (required in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
apiKey (string) – (required in body) VMC API access key. Not mandatory for AAP mode.
nsxHostName (string) – (required in body) The IP address of the NSX Manager server in the specified SDDC / FQDN.
sddcId (string) – (required in body) Identifier of the on-premise SDDC to be used by this cloud account. Note that NSX-V SDDCs are not supported.
password (string) – (required in body) Password for the user used to authenticate with the cloud Account. Not mandatory for AAP mode.
dcId (string) – (required in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Not mandatory for AAP mode.
name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option.
username (string) – (required in body) vCenter user name for the specified SDDC.The specified user requires CloudAdmin credentials. The user does not require CloudGlobalAdmin credentials. Not mandatory for AAP mode.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
validateOnly (string) – (optional in query) If provided, it only validates the credentials in the Cloud Account Specification, and cloud account will not be created.
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting to vSphere
description (string) – (optional in body) A human-friendly description.
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account.Cloud account capability tags may enable different features.
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
environment (string) – (optional in body) The environment where the agent has been deployed. When the agent has been deployed using the “Add Ons” in VMC UI or Api use “aap”.

async idem_vra.exec.vra.iaas.cloudaccount.delete_aws_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Delete an AWS cloud account Delete an AWS cloud account with a given id Performs DELETE /iaas/api/cloud-accounts-aws/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.delete_azure_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Delete an Azure Cloud Account Delete an Azure Cloud Account with a given id Performs DELETE /iaas/api/cloud-accounts-azure/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.delete_cloud_account_nsx_t(hub, ctx, p_id, **kwargs)[source]#

Delete a NSX-T cloud account Delete a NSX-T cloud account with a given id Performs DELETE /iaas/api/cloud-accounts-nsx-t/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.delete_cloud_account_nsx_v(hub, ctx, p_id, **kwargs)[source]#

Delete a NSV-V cloud account Delete a NSV-V cloud account with a given id Performs DELETE /iaas/api/cloud-accounts-nsx-v/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.delete_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Delete a cloud account Delete a cloud account with a given id Performs DELETE /iaas/api/cloud-accounts/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.delete_gcp_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Delete an GCP cloud account Delete an GCP cloud account with a given id Performs DELETE /iaas/api/cloud-accounts-gcp/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.delete_v_sphere_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Delete a vSphere cloud account Delete a vSphere Cloud Account with a given id Performs DELETE /iaas/api/cloud-accounts-vsphere/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.delete_vcf_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Delete an VCF cloud account Delete an VCF cloud account with a given id Performs DELETE /iaas/api/cloud-accounts-vcf/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.delete_vmc_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Delete an VMC cloud account Delete an VMC cloud account with a given id Performs DELETE /iaas/api/cloud-accounts-vmc/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_aws_regions_async(hub, ctx, **kwargs)[source]#

Get the available regions for specified AWS cloud account Get the available regions for specified AWS cloud account Performs POST /iaas/api/cloud-accounts-aws/region-enumeration

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
accessKeyId (string) – (optional in body) Aws Access key ID. Either provide accessKeyId or provide a cloudAccountId of an existing account.
secretAccessKey (string) – (optional in body) Aws Secret Access Key. Either provide secretAccessKey or provide a cloudAccountId of an existing account.
cloudAccountId (string) – (optional in body) Existing cloud account id. Either provide existing cloud account id, or accessKeyId/secretAccessKey credentials pair.

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_azure_regions_async(hub, ctx, **kwargs)[source]#

Get the available regions for specified Azure cloud account Get the available regions for specified Azure cloud account Performs POST /iaas/api/cloud-accounts-azure/region-enumeration

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
clientApplicationId (string) – (optional in body) Azure Client Application ID. Either provide clientApplicationId or provide a cloudAccountId of an existing account.
clientApplicationSecretKey (string) – (optional in body) Azure Client Application Secret Key. Either provide clientApplicationSecretKey or provide a cloudAccountId of an existing account.
cloudAccountId (string) – (optional in body) Existing cloud account id. Either provide id of existing account, or cloud account credentials: clientApplicationId, clientApplicationSecretKey and tenantId.
tenantId (string) – (optional in body) Azure Tenant ID. Either provide tenantId or provide a cloudAccountId of an existing account.
subscriptionId (string) – (optional in body) Azure Subscribtion ID. Either provide subscriptionId or provide a cloudAccountId of an existing account.

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_gcp_regions_async(hub, ctx, **kwargs)[source]#

Get the available regions for specified GCP cloud account Get the available regions for specified GCP cloud account Performs POST /iaas/api/cloud-accounts-gcp/region-enumeration

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
privateKey (string) – (optional in body) GCP Private key. Either provide privateKey or provide a cloudAccountId of an existing account.
clientEmail (string) – (optional in body) GCP Client email. Either provide clientEmail or provide a cloudAccountId of an existing account.
cloudAccountId (string) – (optional in body) Existing cloud account id. Either provide id of existing account, or cloud account credentials: projectId, privateKeyId, privateKey and clientEmail.
projectId (string) – (optional in body) GCP Project ID. Either provide projectId or provide a cloudAccountId of an existing account.
privateKeyId (string) – (optional in body) GCP Private key ID. Either provide privateKeyId or provide a cloudAccountId of an existing account.

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_private_images_aws(hub, ctx, p_id, **kwargs)[source]#

Enumerate all private images for enabled regions of the specified AWS account Performs POST /iaas/api/cloud-accounts-aws/{id}/private-image-enumeration

Parameters:

p_id (string) – (required in path) Id of AWS cloud account to enumerate
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_private_images_azure(hub, ctx, p_id, **kwargs)[source]#

Enumerate all private images for enabled regions of the specified Azure account Performs POST /iaas/api/cloud-accounts-azure/{id}/private-image-enumeration

Parameters:

p_id (string) – (required in path) Id of Azure cloud account to enumerate
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_private_images_gcp(hub, ctx, p_id, **kwargs)[source]#

Enumerate all private images for enabled regions of the specified GCP account Performs POST /iaas/api/cloud-accounts-gcp/{id}/private-image-enumeration

Parameters:

p_id (string) – (required in path) Id of GCP cloud account to enumerate
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_private_images_v_sphere(hub, ctx, p_id, **kwargs)[source]#

Enumerate all private images for enabled regions of the specified vSphere: account Performs POST /iaas/api/cloud-accounts-vsphere/{id}/private-image-enumeration

Parameters:

p_id (string) – (required in path) Id of vSphere cloud account to enumerate
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_private_images_vcf(hub, ctx, p_id, **kwargs)[source]#

Enumerate all private images for enabled regions of the specified VCF account Performs POST /iaas/api/cloud-accounts-vcf/{id}/private-image-enumeration

Parameters:

p_id (string) – (required in path) Id of VCF cloud account to enumerate
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_private_images_vmc(hub, ctx, p_id, **kwargs)[source]#

Enumerate all private images for enabled regions of the specified VMC account Performs POST /iaas/api/cloud-accounts-vmc/{id}/private-image-enumeration

Parameters:

p_id (string) – (required in path) Id of VMC cloud account to enumerate
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_private_images(hub, ctx, p_id, **kwargs)[source]#

Enumerate all private images for enabled regions of the specified cloud account Performs POST /iaas/api/cloud-accounts/{id}/private-image-enumeration

Parameters:

p_id (string) – (required in path) Id of cloud account to enumerate
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_regions_async(hub, ctx, cloudAccountProperties, **kwargs)[source]#

Get the available regions for specified cloud account Get the available regions for specified cloud account Performs POST /iaas/api/cloud-accounts/region-enumeration

Parameters:

cloudAccountProperties (object) – (required in body) Cloud Account specific properties supplied in as name value pairs. In case of AAP, provide environment property here. Example: “cloudAccountProperties”: { “environment”: “aap” }
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
privateKey (string) – (optional in body) Secret access key or password to be used to authenticate with the cloud account. Either provide privateKey or provide a cloudAccountId of an existing account.
cloudAccountType (string) – (optional in body) Cloud account type
cloudAccountId (string) – (optional in body) Existing cloud account id. Either provide existing cloud account Id, or privateKeyId/privateKey credentials pair.
certificateInfo (Any) – (optional in body)
privateKeyId (string) – (optional in body) Access key id or username to be used to authenticate with the cloud account. Either provide privateKeyId or provide a cloudAccountId of an existing account.

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_v_sphere_regions_async(hub, ctx, **kwargs)[source]#

Get the available regions for specified vSphere cloud account Get the available regions for specified vSphere cloud account Performs POST /iaas/api/cloud-accounts-vsphere/region-enumeration

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
hostName (string) – (optional in body) Host name for the vSphere endpoint. Either provide hostName or provide a cloudAccountId of an existing account.
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting to vSphere
password (string) – (optional in body) Password for the user used to authenticate with the cloud Account. Either provide password or provide a cloudAccountId of an existing account.
dcid (string) – (optional in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in vRA on-prem release.
cloudAccountId (string) – (optional in body) Existing cloud account id. Either provide existing cloud account Id, or hostName, username, password.
certificateInfo (Any) – (optional in body)
username (string) – (optional in body) Username to authenticate with the cloud account. Either provide username or provide a cloudAccountId of an existing account.

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_vcf_regions_async(hub, ctx, **kwargs)[source]#

Get the available regions for specified VCF cloud account Get the available regions for specified VCF cloud account Performs POST /iaas/api/cloud-accounts-vcf/region-enumeration

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
vcenterPassword (string) – (optional in body) Password for the user used to authenticate with the vCenter in VCF cloud account. Either provide vcenterPassword or provide a cloudAccountId of an existing account.
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting to vSphere and NSX-T
nsxHostName (string) – (optional in body) Host name for the NSX endpoint from the specified workload domain. Either provide nsxHostName or provide a cloudAccountId of an existing account.
vcenterUsername (string) – (optional in body) vCenter user name for the specified workload domain.The specified user requires CloudAdmin credentials. The user does not require CloudGlobalAdmin credentials.
cloudAccountId (string) – (optional in body) Existing cloud account id. Either provide existing cloud account Id, or workloadDomainId, workloadDomainName, vcenterHostName, vcenterUsername, vcenterPassword, nsxHostName, nsxUsername and nsxPassword.
sddcManagerId (string) – (optional in body) SDDC manager integration id. Either provide sddcManagerId or provide a cloudAccountId of an existing account.
certificateInfo (Any) – (optional in body)
vcenterHostName (string) – (optional in body) Host name for the vSphere from the specified workload domain. Either provide vcenterHostName or provide a cloudAccountId of an existing account.
nsxCertificate (string) – (optional in body) NSX Certificate
nsxUsername (string) – (optional in body) User name for the NSX manager in the specified workload domain. Either provide nsxUsername or provide a cloudAccountId of an existing account.
workloadDomainName (string) – (optional in body) Name of the workload domain to add as VCF cloud account. Either provide workloadDomainName or provide a cloudAccountId of an existing account.
nsxPassword (string) – (optional in body) Password for the user used to authenticate with the NSX-T manager in VCF cloud account. Either provide nsxPassword or provide a cloudAccountId of an existing account.
vcenterCertificate (string) – (optional in body) vCenter Certificate
dcId (string) – (optional in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in vRA on-prem release.
workloadDomainId (string) – (optional in body) Id of the workload domain to add as VCF cloud account. Either provide workloadDomainId or provide a cloudAccountId of an existing account.

async idem_vra.exec.vra.iaas.cloudaccount.enumerate_vmc_regions_async(hub, ctx, **kwargs)[source]#

Get the available regions for specified VMC cloud account Get the available regions for specified VMC cloud account Performs POST /iaas/api/cloud-accounts-vmc/region-enumeration

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
hostName (string) – (optional in body) Enter the IP address or FQDN of the vCenter Server in the specified SDDC. The cloud proxy belongs on this vCenter. Either provide hostName or provide a cloudAccountId of an existing account.
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting to vSphere
password (string) – (optional in body) Password for the user used to authenticate with the cloud Account. Either provide password or provide a cloudAccountId of an existing account.
environment (string) – (optional in body) The environment where the agent has been deployed. When the agent has been deployed using the “Add Ons” in VMC UI or Api use “aap”.
apiKey (string) – (optional in body) VMC API access key. Either provide apiKey or provide a cloudAccountId of an existing account.
dcId (string) – (optional in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors
nsxHostName (string) – (optional in body) The IP address of the NSX Manager server in the specified SDDC / FQDN.Either provide nsxHostName or provide a cloudAccountId of an existing account.
sddcId (string) – (optional in body) Identifier of the on-premise SDDC to be used by this cloud account. Note that NSX-V SDDCs are not supported. Either provide sddcId or provide a cloudAccountId of an existing account.
cloudAccountId (string) – (optional in body) Existing cloud account id. Either provide existing cloud account Id, or apiKey, sddcId, username, password, hostName, nsxHostName.
certificateInfo (Any) – (optional in body)
username (string) – (optional in body) vCenter user name for the specified SDDC.The specified user requires CloudAdmin credentials. The user does not require CloudGlobalAdmin credentials.Either provide username or provide a cloudAccountId of an existing account.
cspHostName (string) – (optional in body) The host name of the CSP service.

async idem_vra.exec.vra.iaas.cloudaccount.get_aws_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Get an AWS cloud account Get an AWS cloud account with a given id Performs GET /iaas/api/cloud-accounts-aws/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.get_aws_cloud_accounts(hub, ctx, **kwargs)[source]#

Get AWS cloud accounts Get all AWS cloud accounts within the current organization Performs GET /iaas/api/cloud-accounts-aws

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
top (integer) – (optional in query) Number of records you want to get.
skip (integer) – (optional in query) Number of records you want to skip.

async idem_vra.exec.vra.iaas.cloudaccount.get_azure_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Get an Azure Cloud Account Get an Azure Cloud Account with a given id Performs GET /iaas/api/cloud-accounts-azure/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.get_azure_cloud_accounts(hub, ctx, **kwargs)[source]#

Get Azure cloud accounts Get all Azure cloud accounts within the current organization Performs GET /iaas/api/cloud-accounts-azure

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
top (integer) – (optional in query) Number of records you want to get.
skip (integer) – (optional in query) Number of records you want to skip.

async idem_vra.exec.vra.iaas.cloudaccount.get_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Get cloud account Get cloud account with a given id Performs GET /iaas/api/cloud-accounts/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
select (string) – (optional in query) Select a subset of properties to include in the response.

async idem_vra.exec.vra.iaas.cloudaccount.get_cloud_accounts(hub, ctx, **kwargs)[source]#

Get cloud accounts Get all cloud accounts within the current organization Performs GET /iaas/api/cloud-accounts

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
top (integer) – (optional in query) Number of records you want to get.
skip (integer) – (optional in query) Number of records you want to skip.
count (boolean) – (optional in query) Flag which when specified, regardless of the assigned value, shows the total number of records. If the collection has a filter it shows the number of records matching the filter.
select (string) – (optional in query) Select a subset of properties to include in the response.
filter (string) – (optional in query) Filter the results by a specified predicate expression. Operators: eq, ne, and, or.

async idem_vra.exec.vra.iaas.cloudaccount.get_gcp_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Get an GCP cloud account Get an GCP cloud account with a given id Performs GET /iaas/api/cloud-accounts-gcp/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.get_gcp_cloud_accounts(hub, ctx, **kwargs)[source]#

Get GCP cloud accounts Get all GCP cloud accounts within the current organization Performs GET /iaas/api/cloud-accounts-gcp

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
top (integer) – (optional in query) Number of records you want to get.
skip (integer) – (optional in query) Number of records you want to skip.

async idem_vra.exec.vra.iaas.cloudaccount.get_nsx_t_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Get an NSX-T cloud account Get an NSX-T cloud account with a given id Performs GET /iaas/api/cloud-accounts-nsx-t/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.get_nsx_t_cloud_accounts(hub, ctx, **kwargs)[source]#

Get NSX-T cloud accounts Get all NSX-T cloud accounts within the current organization Performs GET /iaas/api/cloud-accounts-nsx-t

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
top (integer) – (optional in query) Number of records you want to get.
skip (integer) – (optional in query) Number of records you want to skip.

async idem_vra.exec.vra.iaas.cloudaccount.get_nsx_v_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Get an NSX-V cloud account Get an NSX-V cloud account with a given id Performs GET /iaas/api/cloud-accounts-nsx-v/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.get_nsx_v_cloud_accounts(hub, ctx, **kwargs)[source]#

Get NSX-V cloud accounts Get all NSX-V cloud accounts within the current organization Performs GET /iaas/api/cloud-accounts-nsx-v

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
top (integer) – (optional in query) Number of records you want to get.
skip (integer) – (optional in query) Number of records you want to skip.

async idem_vra.exec.vra.iaas.cloudaccount.get_region_enumeration_result(hub, ctx, p_id, **kwargs)[source]#

Get region enumeration response Get region enumeration response for a given id Performs GET /iaas/api/cloud-accounts/region-enumeration/{id}

Parameters:

p_id (string) – (required in path) The ID of enumeration response
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.get_v_sphere_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Get an vSphere cloud account Get an vSphere cloud account with a given id Performs GET /iaas/api/cloud-accounts-vsphere/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.get_v_sphere_cloud_accounts(hub, ctx, **kwargs)[source]#

Get vSphere cloud accounts Get all vSphere cloud accounts within the current organization Performs GET /iaas/api/cloud-accounts-vsphere

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
top (integer) – (optional in query) Number of records you want to get.
skip (integer) – (optional in query) Number of records you want to skip.

async idem_vra.exec.vra.iaas.cloudaccount.get_vcf_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Get an VCF cloud account Get an VCF cloud account with a given id Performs GET /iaas/api/cloud-accounts-vcf/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.get_vcf_cloud_accounts(hub, ctx, **kwargs)[source]#

Get VCF cloud accounts Get all VCF cloud accounts within the current organization Performs GET /iaas/api/cloud-accounts-vcf

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
top (integer) – (optional in query) Number of records you want to get.
skip (integer) – (optional in query) Number of records you want to skip.

async idem_vra.exec.vra.iaas.cloudaccount.get_vmc_cloud_account(hub, ctx, p_id, **kwargs)[source]#

Get an VMC cloud account Get an VMC cloud account with a given id Performs GET /iaas/api/cloud-accounts-vmc/{id}

Parameters:

p_id (string) – (required in path) The ID of the Cloud Account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

async idem_vra.exec.vra.iaas.cloudaccount.get_vmc_cloud_accounts(hub, ctx, **kwargs)[source]#

Get VMC cloud accounts Get all VMC cloud accounts within the current organization Performs GET /iaas/api/cloud-accounts-vmc

Parameters:

apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
top (integer) – (optional in query) Number of records you want to get.
skip (integer) – (optional in query) Number of records you want to skip.

async idem_vra.exec.vra.iaas.cloudaccount.run_endpoint_health_check(hub, ctx, p_id, **kwargs)[source]#

Starts cloud account health check Starts cloud account health check identified by its endpoint state Performs POST /iaas/api/cloud-accounts/{id}/health-check

Parameters:

p_id (string) – (required in path) The ID of the Cloud account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
periodicHealthCheckId (string) – (optional in query) If query param is provided then the endpoint health check is not started manually from the UI, but after a scheduled process.

async idem_vra.exec.vra.iaas.cloudaccount.update_aws_cloud_account_async(hub, ctx, p_id, accessKeyId, secretAccessKey, **kwargs)[source]#

Update AWS cloud account Update AWS cloud account Performs PATCH /iaas/api/cloud-accounts-aws/{id}

Parameters:

p_id (string) – (required in path) Cloud account id
accessKeyId (string) – (required in body) Aws Access key ID
secretAccessKey (string) – (required in body) Aws Secret Access Key
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
regions (array) – (optional in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
name (string) – (optional in body) A human-friendly name used as an identifier in APIs that support this option.
description (string) – (optional in body) A human-friendly description.
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.update_azure_cloud_account_async(hub, ctx, p_id, clientApplicationId, clientApplicationSecretKey, tenantId, subscriptionId, **kwargs)[source]#

Update Azure cloud account Update Azure cloud account Performs PATCH /iaas/api/cloud-accounts-azure/{id}

Parameters:

p_id (string) – (required in path) Cloud account id
clientApplicationId (string) – (required in body) Azure Client Application ID
clientApplicationSecretKey (string) – (required in body) Azure Client Application Secret Key
tenantId (string) – (required in body) Azure Tenant ID
subscriptionId (string) – (required in body) Azure Subscribtion ID
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
regions (array) – (optional in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
name (string) – (optional in body) A human-friendly name used as an identifier in APIs that support this option.
description (string) – (optional in body) A human-friendly description.
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.update_cloud_account_async(hub, ctx, p_id, privateKey, privateKeyId, **kwargs)[source]#

Update CloudAccount Update a single CloudAccount Performs PATCH /iaas/api/cloud-accounts/{id}

Parameters:

p_id (string) – (required in path) The ID of the cloudAccount
privateKey (string) – (required in body) Secret access key or password to be used to authenticate with the cloud account. In case of AAP pass a dummy value.
privateKeyId (string) – (required in body) Access key id or username to be used to authenticate with the cloud account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
cloudAccountProperties (object) – (optional in body) Cloud Account specific properties supplied in as name value pairs
associatedCloudAccountIds (array) – (optional in body) Cloud accounts to associate with this cloud account
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
customProperties (object) – (optional in body) Additional custom properties that may be used to extend the Cloud Account. In case of AAP, provide environment property here.Example: “customProperties”: { “environment”: “aap” }
regions (array) – (optional in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration. ‘regionInfos’ is a required parameter for AWS, AZURE, GCP, VSPHERE, VMC, VCF cloud account types.
name (string) – (optional in body) A human-friendly name used as an identifier in APIs that support this option.
description (string) – (optional in body) A human-friendly description.
associatedMobilityCloudAccountIds (object) – (optional in body) Cloud Account IDs and directionalities create associations to other vSphere cloud accounts that can be used for workload mobility. ID refers to an associated cloud account, and directionality can be unidirectional or bidirectional. Only supported on vSphere cloud accounts.
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.update_gcp_cloud_account_async(hub, ctx, p_id, privateKey, clientEmail, projectId, privateKeyId, **kwargs)[source]#

Update GCP cloud account Update GCP cloud account Performs PATCH /iaas/api/cloud-accounts-gcp/{id}

Parameters:

p_id (string) – (required in path) Cloud account id
privateKey (string) – (required in body) GCP Private key
clientEmail (string) – (required in body) GCP Client email
projectId (string) – (required in body) GCP Project ID
privateKeyId (string) – (required in body) GCP Private key ID
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
regions (array) – (optional in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
name (string) – (optional in body) A human-friendly name used as an identifier in APIs that support this option.
description (string) – (optional in body) A human-friendly description.
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.update_nsx_t_cloud_account_async(hub, ctx, p_id, hostName, password, dcid, username, **kwargs)[source]#

Update NSX-T cloud account Update NSX-T cloud account Performs PATCH /iaas/api/cloud-accounts-nsx-t/{id}

Parameters:

p_id (string) – (required in path) Cloud account id
hostName (string) – (required in body) Host name for the NSX-T endpoint
password (string) – (required in body) Password for the user used to authenticate with the cloud Account
dcid (string) – (required in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in vRA on-prem release and hence the data collector Id is optional for vRA on-prem.
username (string) – (required in body) Username to authenticate with the cloud account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting.
associatedCloudAccountIds (array) – (optional in body) vSphere cloud accounts associated with this NSX-T cloud account.
name (string) – (optional in body) A human-friendly name used as an identifier in APIs that support this option.
description (string) – (optional in body) A human-friendly description.
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.update_nsx_v_cloud_account_async(hub, ctx, p_id, hostName, password, dcid, username, **kwargs)[source]#

Update NSX-V cloud account Update NSX-V cloud account Performs PATCH /iaas/api/cloud-accounts-nsx-v/{id}

Parameters:

p_id (string) – (required in path) Cloud account id
hostName (string) – (required in body) Host name for the NSX-v endpoint
password (string) – (required in body) Password for the user used to authenticate with the cloud Account
dcid (string) – (required in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in vRA on-prem release and hence the data collector Id is optional for vRA on-prem.
username (string) – (required in body) Username to authenticate with the cloud account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting.
associatedCloudAccountIds (array) – (optional in body) vSphere cloud account associated with this NSX-V cloud account. NSX-V cloud account can be associated with a single vSphere cloud account.
name (string) – (optional in body) A human-friendly name used as an identifier in APIs that support this option.
description (string) – (optional in body) A human-friendly description.
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account

async idem_vra.exec.vra.iaas.cloudaccount.update_v_sphere_cloud_account_async(hub, ctx, p_id, hostName, password, username, **kwargs)[source]#

Update vSphere cloud account Update vSphere cloud account Performs PATCH /iaas/api/cloud-accounts-vsphere/{id}

Parameters:

p_id (string) – (required in path) Cloud account id
hostName (string) – (required in body) Host name for the vSphere endpoint
password (string) – (required in body) Password for the user used to authenticate with the cloud Account
username (string) – (required in body) Username to authenticate with the cloud account
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting to vSphere
associatedCloudAccountIds (array) – (optional in body) NSX-V or NSX-T account to associate with this vSphere cloud account. vSphere cloud account can be a single NSX-V cloud account or a single NSX-T cloud account.
regions (array) – (optional in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
description (string) – (optional in body) A human-friendly description.
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
dcid (string) – (optional in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in vRA on-prem release.
name (string) – (optional in body) A human-friendly name used as an identifier in APIs that support this option.
associatedMobilityCloudAccountIds (object) – (optional in body) Cloud account IDs and directionalities create associations to other vSphere cloud accounts that can be used for workload mobility. ID refers to an associated cloud account, and directionality can be unidirectional or bidirectional.

async idem_vra.exec.vra.iaas.cloudaccount.update_vcf_cloud_account_async(hub, ctx, p_id, vcenterPassword, nsxHostName, vcenterUsername, vcenterHostName, nsxUsername, workloadDomainName, nsxPassword, workloadDomainId, **kwargs)[source]#

Update VCF cloud account Update VCF cloud account Performs PATCH /iaas/api/cloud-accounts-vcf/{id}

Parameters:

p_id (string) – (required in path) Cloud account id
vcenterPassword (string) – (required in body) Password for the user used to authenticate with the vCenter in VCF cloud account
nsxHostName (string) – (required in body) Host name for the NSX endpoint from the specified workload domain.
vcenterUsername (string) – (required in body) vCenter user name for the specified workload domain.The specified user requires CloudAdmin credentials. The user does not require CloudGlobalAdmin credentials.
vcenterHostName (string) – (required in body) Host name for the vSphere from the specified workload domain.
nsxUsername (string) – (required in body) User name for the NSX manager in the specified workload domain.
workloadDomainName (string) – (required in body) Name of the workload domain to add as VCF cloud account.
nsxPassword (string) – (required in body) Password for the user used to authenticate with the NSX-T manager in VCF cloud account
workloadDomainId (string) – (required in body) Id of the workload domain to add as VCF cloud account.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting to vSphere and NSX-T
regions (array) – (optional in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
description (string) – (optional in body) A human-friendly description.
sddcManagerId (string) – (optional in body) SDDC manager integration id
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account.Cloud account capability tags may enable different features.
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
nsxCertificate (string) – (optional in body) NSX Certificate
vcenterCertificate (string) – (optional in body) vCenter Certificate
dcId (string) – (optional in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Note: Data collector endpoints are not available in vRA on-prem release.
name (string) – (optional in body) A human-friendly name used as an identifier in APIs that support this option.

async idem_vra.exec.vra.iaas.cloudaccount.update_vmc_cloud_account_async(hub, ctx, p_id, hostName, nsxHostName, sddcId, password, dcId, username, **kwargs)[source]#

Update VMC cloud account Update VMC cloud account Performs PATCH /iaas/api/cloud-accounts-vmc/{id}

Parameters:

p_id (string) – (required in path) Cloud account id
hostName (string) – (required in body) Enter the IP address or FQDN of the vCenter Server in the specified SDDC. The cloud proxy belongs on this vCenter.
nsxHostName (string) – (required in body) The IP address of the NSX Manager server in the specified SDDC / FQDN.
sddcId (string) – (required in body) Identifier of the on-premise SDDC to be used by this cloud account. Note that NSX-V SDDCs are not supported.
password (string) – (required in body) Password for the user used to authenticate with the cloud Account. Not mandatory for AAP mode.
dcId (string) – (required in body) Identifier of a data collector vm deployed in the on premise infrastructure. Refer to the data-collector API to create or list data collectors. Not mandatory for AAP mode.
username (string) – (required in body) vCenter user name for the specified SDDC.The specified user requires CloudAdmin credentials. The user does not require CloudGlobalAdmin credentials. Not mandatory for AAP mode.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
acceptSelfSignedCertificate (boolean) – (optional in body) Accept self signed certificate when connecting to vSphere
regions (array) – (optional in body) A set of regions to enable provisioning on.Refer to /iaas/api/cloud- accounts/region-enumeration.
apiKey (string) – (optional in body) VMC API access key. Optional when updating.
description (string) – (optional in body) A human-friendly description.
certificateInfo (Any) – (optional in body)
tags (array) – (optional in body) A set of tag keys and optional values to set on the Cloud Account.Cloud account capability tags may enable different features.
createDefaultZones (boolean) – (optional in body) Create default cloud zones for the enabled regions.
environment (string) – (optional in body) The environment where the agent has been deployed. When the agent has been deployed using the “Add Ons” in VMC UI or Api use “aap”.
name (string) – (optional in body) A human-friendly name used as an identifier in APIs that support this option.