\ - <%username%>\ - \ - <%time.delta%>\ -
\ -\ - \ - reply ▿\ - proposal ▹\ - \ - \ - \ -
\ -\ -<#proposal_diff#>\ -\ -
com.vmware.vmc_client module¶
-
-class
com.vmware.vmc_client.Locale(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
set(vmc_locale)¶
+ Sets the locale for the session which is used for translating responses.
--
+- - - Parameters: vmc_locale ( -com.vmware.vmc.model_client.VmcLocale) – The locale to be set. (required)Return type: com.vmware.vmc.model_client.VmcLocaleReturns: com.vmware.vmc.model.VmcLocale -Raise: com.vmware.vapi.std.errors_client.Unauthenticated-UnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized-Forbidden-
+
- Parameters +
vmc_locale (
+com.vmware.vmc.model_client.VmcLocale) – The locale to be set. (required)
+- Return type +
- + +
- Returns +
com.vmware.vmc.model.VmcLocale
+
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthenticated+Unauthorized
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthorized+Forbidden
+
set(vmc_locale)¶
com.vmware.vmc_client.Locale(config)¶
-
-class
com.vmware.vmc_client.Orgs(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org)¶
+ Get details of organization
--
+- - - Parameters: org ( -str) – Organization identifier. (required)Return type: com.vmware.vmc.model_client.OrganizationReturns: com.vmware.vmc.model.Organization -Raise: com.vmware.vapi.std.errors_client.Unauthenticated-UnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized-ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound-Organization doesn’t exist-
+
- Parameters +
org (
+str) – Organization identifier. (required)
+- Return type +
- + +
- Returns +
com.vmware.vmc.model.Organization
+
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthenticated+Unauthorized
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthorized+Forbidden
+- Raise +
+com.vmware.vapi.std.errors_client.NotFound+Organization doesn’t exist
+
get(org)¶-
-
list()¶
+ Return a list of all organizations the calling user (based on credential) is authorized on.
--
+- - - Return type: listofcom.vmware.vmc.model_client.OrganizationReturns: - Raise: com.vmware.vapi.std.errors_client.Unauthenticated-UnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized-Forbidden-
+
- Return type +
- + +
- Returns +
- + +
- Raise +
+com.vmware.vapi.std.errors_client.Unauthenticated+Unauthorized
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthorized+Forbidden
+
list()¶
com.vmware.vmc_client.Orgs(config)¶
-
-class
com.vmware.vmc_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc_client.StubFactory(stub_config)¶
com.vmware.vmc.model_client module¶
-
-class
com.vmware.vmc.model_client.AbstractEntity(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- updated (
datetime.datetime) –
- - user_id (
str) – User id that last updated this record
- - updated_by_user_id (
str) – User id that last updated this record
- - created (
datetime.datetime) –
- - version (
long) – Version of this entity format: int32
- - updated_by_user_name (
strorNone) – User name that last updated this record
- - user_name (
str) – User name that last updated this record
- - id (
str) – Unique ID for this entity
+ - Parameters +
-
+
updated (
datetime.datetime) –
+user_id (
str) – User id that last updated this record
+updated_by_user_id (
str) – User id that last updated this record
+created (
datetime.datetime) –
+version (
long) – Version of this entity format: int32
+updated_by_user_name (
strorNone) – User name that last updated this record
+user_name (
str) – User name that last updated this record
+id (
str) – Unique ID for this entity
-
+
+- updated (
com.vmware.vmc.model_client.AbstractEntity(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None)¶
-
-class
com.vmware.vmc.model_client.AccountLinkConfig(delay_account_link=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: delay_account_link ( -boolorNone) – Boolean flag identifying whether account linking should be delayed -or not for the SDDC.-
+
- Parameters +
delay_account_link (
+boolorNone) – Boolean flag identifying whether account linking should be delayed +or not for the SDDC.
+
com.vmware.vmc.model_client.AccountLinkConfig(delay_account_link=None)¶
-
-class
com.vmware.vmc.model_client.AccountLinkSddcConfig(customer_subnet_ids=None, connected_account_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- customer_subnet_ids (
listofstrorNone) –
- - connected_account_id (
strorNone) – The ID of the customer connected account to work with.
+ - Parameters +
-
+
customer_subnet_ids (
listofstrorNone) –
+connected_account_id (
strorNone) – The ID of the customer connected account to work with.
-
+
+- customer_subnet_ids (
com.vmware.vmc.model_client.AccountLinkSddcConfig(customer_subnet_ids=None, connected_account_id=None)¶
-
-class
com.vmware.vmc.model_client.AddressFWSourceDestination(exclude=None, ip_address=None, grouping_object_id=None, vnic_group_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructSource or Destination for firewall rule. Default is ‘any’.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- exclude (
boolorNone) – Exclude the specified source or destination.
- - ip_address (
listofstrorNone) – List of string. Can specify single IP address, range of IP address, -or in CIDR format. Can define multiple.
- - grouping_object_id (
listofstrorNone) – List of string. Id of cluster, datacenter, distributedPortGroup, +-
+
- Parameters +
-
+
exclude (
boolorNone) – Exclude the specified source or destination.
+ip_address (
listofstrorNone) – List of string. Can specify single IP address, range of IP address, +or in CIDR format. Can define multiple.
+grouping_object_id (
listofstrorNone) – List of string. Id of cluster, datacenter, distributedPortGroup, legacyPortGroup, VirtualMachine, vApp, resourcePool, logicalSwitch, -IPSet, securityGroup. Can define multiple.
-- vnic_group_id (
listofstrorNone) – List of string. Possible values are vnic-index-[1-9], vse, external -or internal. Can define multiple.
+IPSet, securityGroup. Can define multiple.
+ vnic_group_id (
listofstrorNone) – List of string. Possible values are vnic-index-[1-9], vse, external +or internal. Can define multiple.
+- exclude (
com.vmware.vmc.model_client.AddressFWSourceDestination(exclude=None, ip_address=None, grouping_object_id=None, vnic_group_id=None)¶
-
-class
com.vmware.vmc.model_client.Agent(cert_enabled=None, internal_ip=None, hostname_verifier_enabled=None, network_netmask=None, network_gateway=None, provider='Agent', is_master=None, agent_state=None, agent_url=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- cert_enabled (
boolorNone) – Boolean flag to indicate if the agent is using CA signed -certificate
- - internal_ip (
strorNone) – Internal IP address of the agent
- - hostname_verifier_enabled (
boolorNone) – Boolean flag to indicate if the agent is using FQDN in the -certificate
- - network_netmask (
strorNone) – Network netmask of the agent
- - network_gateway (
strorNone) – Network gateway of the agent
- - provider (
str) – The cloud provider
- - is_master (
boolorNone) – Boolean flag to indicate if the agent is the master, only the -master Agent is accessible
- - agent_state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
cert_enabled (
boolorNone) – Boolean flag to indicate if the agent is using CA signed +certificate
+internal_ip (
strorNone) – Internal IP address of the agent
+hostname_verifier_enabled (
boolorNone) – Boolean flag to indicate if the agent is using FQDN in the +certificate
+network_netmask (
strorNone) – Network netmask of the agent
+network_gateway (
strorNone) – Network gateway of the agent
+provider (
str) – The cloud provider
+is_master (
boolorNone) – Boolean flag to indicate if the agent is the master, only the +master Agent is accessible
+agent_state (
strorNone) –Possible values are:
-
-
Agent.AGENT_STATE_NOT_READY
-Agent.AGENT_STATE_DEPLOYING
-Agent.AGENT_STATE_CUSTOMIZING
-Agent.AGENT_STATE_READY
-Agent.AGENT_STATE_DELETING
-Agent.AGENT_STATE_DELETED
-Agent.AGENT_STATE_FAILED
+- +
- +
- +
- +
- +
- +
-
-Agent state
-- agent_url (
strorNone) – The accessible URL of the agent service, it is resolved to public -IP address from the Internet and private IP address within SDDC
+
+Agent state
+
+ agent_url (
strorNone) – The accessible URL of the agent service, it is resolved to public +IP address from the Internet and private IP address within SDDC
+- cert_enabled (
com.vmware.vmc.model_client.Agent(cert_enabled=None, internal_ip=None, hostname_verifier_enabled=None, network_netmask=None, network_gateway=None, provider='Agent', is_master=None, agent_state=None, agent_url=None)¶
-
+
@@ -444,146 +426,131 @@ IP address from the Internet and private IP address within SDDC
-
-class
com.vmware.vmc.model_client.AmiInfo(region=None, id=None, name=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructthe AmiInfo used for deploying esx of the sddc
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- region (
strorNone) – the region of the esx ami
- - id (
strorNone) – the ami id for the esx
- - name (
strorNone) – the name of the esx ami
+ - Parameters +
-
+
region (
strorNone) – the region of the esx ami
+id (
strorNone) – the ami id for the esx
+name (
strorNone) – the name of the esx ami
-
+
+- region (
com.vmware.vmc.model_client.AmiInfo(region=None, id=None, name=None)¶
-
-class
com.vmware.vmc.model_client.AppliancesSummary(data_store_moid_of_active_vse=None, enable_fips=None, host_name_of_active_vse=None, vm_build_info=None, deploy_appliances=None, communication_channel=None, vm_name_of_active_vse=None, number_of_deployed_vms=None, resource_pool_moid_of_active_vse=None, data_store_name_of_active_vse=None, vm_moid_of_active_vse=None, status_from_vse_updated_on=None, fqdn=None, appliance_size=None, resource_pool_name_of_active_vse=None, active_vse_ha_index=None, vm_version=None, host_moid_of_active_vse=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNSX Edge appliance summary.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- data_store_moid_of_active_vse (
strorNone) – vCenter MOID of the active NSX Edge appliance’s data store.
- - enable_fips (
boolorNone) – Value is true if FIPS is enabled on NSX Edge appliance.
- - host_name_of_active_vse (
strorNone) – Host name of the active NSX Edge appliance.
- - vm_build_info (
strorNone) – NSX Edge appliance build version.
- - deploy_appliances (
boolorNone) – Value is true if NSX Edge appliances are to be deployed.
- - communication_channel (
strorNone) – Communication channel used to communicate with NSX Edge appliance.
- - vm_name_of_active_vse (
strorNone) – Name of the active NSX Edge appliance.
- - number_of_deployed_vms (
longorNone) – Number of deployed appliances of the NSX Edge. format: int32
- - resource_pool_moid_of_active_vse (
strorNone) – vCenter MOID of the active NSX Edge appliance’s resource +-
+
- Parameters +
-
+
data_store_moid_of_active_vse (
strorNone) – vCenter MOID of the active NSX Edge appliance’s data store.
+enable_fips (
boolorNone) – Value is true if FIPS is enabled on NSX Edge appliance.
+host_name_of_active_vse (
strorNone) – Host name of the active NSX Edge appliance.
+vm_build_info (
strorNone) – NSX Edge appliance build version.
+deploy_appliances (
boolorNone) – Value is true if NSX Edge appliances are to be deployed.
+communication_channel (
strorNone) – Communication channel used to communicate with NSX Edge appliance.
+vm_name_of_active_vse (
strorNone) – Name of the active NSX Edge appliance.
+number_of_deployed_vms (
longorNone) – Number of deployed appliances of the NSX Edge. format: int32
+resource_pool_moid_of_active_vse (
strorNone) – vCenter MOID of the active NSX Edge appliance’s resource pool/cluster. Can be resource pool ID, e.g. resgroup-15 or cluster -ID, e.g. domain-c41.
-- data_store_name_of_active_vse (
strorNone) – Datastore name of the active NSX Edge appliance.
- - vm_moid_of_active_vse (
strorNone) – vCenter MOID of the active NSX Edge appliance.
- - status_from_vse_updated_on (
longorNone) – Time stamp value when healthcheck status was last updated for the -NSX Edge appliance. format: int64
- - fqdn (
strorNone) – FQDN of the NSX Edge.
- - appliance_size (
strorNone) – NSX Edge appliance size.
- - resource_pool_name_of_active_vse (
strorNone) – Resource Pool/Cluster name of the active NSX Edge appliance.
- - active_vse_ha_index (
longorNone) – HA index of the active NSX Edge appliance. format: int32
- - vm_version (
strorNone) – NSX Edge appliance version.
- - host_moid_of_active_vse (
strorNone) – vCenter MOID of the active NSX Edge appliance’s host.
+ID, e.g. domain-c41.
+ data_store_name_of_active_vse (
strorNone) – Datastore name of the active NSX Edge appliance.
+vm_moid_of_active_vse (
strorNone) – vCenter MOID of the active NSX Edge appliance.
+status_from_vse_updated_on (
longorNone) – Time stamp value when healthcheck status was last updated for the +NSX Edge appliance. format: int64
+fqdn (
strorNone) – FQDN of the NSX Edge.
+appliance_size (
strorNone) – NSX Edge appliance size.
+resource_pool_name_of_active_vse (
strorNone) – Resource Pool/Cluster name of the active NSX Edge appliance.
+active_vse_ha_index (
longorNone) – HA index of the active NSX Edge appliance. format: int32
+vm_version (
strorNone) – NSX Edge appliance version.
+host_moid_of_active_vse (
strorNone) – vCenter MOID of the active NSX Edge appliance’s host.
+- data_store_moid_of_active_vse (
com.vmware.vmc.model_client.AppliancesSummary(data_store_moid_of_active_vse=None, enable_fips=None, host_name_of_active_vse=None, vm_build_info=None, deploy_appliances=None, communication_channel=None, vm_name_of_active_vse=None, number_of_deployed_vms=None, resource_pool_moid_of_active_vse=None, data_store_name_of_active_vse=None, vm_moid_of_active_vse=None, status_from_vse_updated_on=None, fqdn=None, appliance_size=None, resource_pool_name_of_active_vse=None, active_vse_ha_index=None, vm_version=None, host_moid_of_active_vse=None)¶
-
-class
com.vmware.vmc.model_client.Application(application_id=None, service=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructApplication for firewall rule
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- application_id (
listofstrorNone) – List of string. Id of service or serviceGroup groupingObject. Can -define multiple.
- - service (
listofNsxfirewallserviceorNone) – List of protocol and ports. Can define multiple.
+ - Parameters +
-
+
application_id (
listofstrorNone) – List of string. Id of service or serviceGroup groupingObject. Can +define multiple.
+service (
listofNsxfirewallserviceorNone) – List of protocol and ports. Can define multiple.
-
+
+- application_id (
com.vmware.vmc.model_client.Application(application_id=None, service=None)¶
-
-class
com.vmware.vmc.model_client.AwsAgent(instance_id=None, key_pair=None, cert_enabled=None, internal_ip=None, hostname_verifier_enabled=None, network_netmask=None, network_gateway=None, provider='AWS', is_master=None, agent_state=None, agent_url=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
-- - - Parameters: -
-
- instance_id (
strorNone) –
- - key_pair (
AwsKeyPairorNone) –
- - cert_enabled (
boolorNone) – Boolean flag to indicate if the agent is using CA signed -certificate
- - internal_ip (
strorNone) – Internal IP address of the agent
- - hostname_verifier_enabled (
boolorNone) – Boolean flag to indicate if the agent is using FQDN in the -certificate
- - network_netmask (
strorNone) – Network netmask of the agent
- - network_gateway (
strorNone) – Network gateway of the agent
- - provider (
str) – The cloud provider
- - is_master (
boolorNone) – Boolean flag to indicate if the agent is the master, only the -master Agent is accessible
- - agent_state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
instance_id (
strorNone) –
+key_pair (
AwsKeyPairorNone) –
+cert_enabled (
boolorNone) – Boolean flag to indicate if the agent is using CA signed +certificate
+internal_ip (
strorNone) – Internal IP address of the agent
+hostname_verifier_enabled (
boolorNone) – Boolean flag to indicate if the agent is using FQDN in the +certificate
+network_netmask (
strorNone) – Network netmask of the agent
+network_gateway (
strorNone) – Network gateway of the agent
+provider (
str) – The cloud provider
+is_master (
boolorNone) – Boolean flag to indicate if the agent is the master, only the +master Agent is accessible
+agent_state (
strorNone) –Possible values are:
-
-
Agent.AGENT_STATE_NOT_READY
-Agent.AGENT_STATE_DEPLOYING
-Agent.AGENT_STATE_CUSTOMIZING
-Agent.AGENT_STATE_READY
-Agent.AGENT_STATE_DELETING
-Agent.AGENT_STATE_DELETED
-Agent.AGENT_STATE_FAILED
+- +
- +
- +
- +
- +
- +
-
-Agent state
-- agent_url (
strorNone) – The accessible URL of the agent service, it is resolved to public -IP address from the Internet and private IP address within SDDC
+
+Agent state
+
+ agent_url (
strorNone) – The accessible URL of the agent service, it is resolved to public +IP address from the Internet and private IP address within SDDC
-
+
+- instance_id (
com.vmware.vmc.model_client.AwsAgent(instance_id=None, key_pair=None, cert_enabled=None, internal_ip=None, hostname_verifier_enabled=None, network_netmask=None, network_gateway=None, provider='AWS', is_master=None, agent_state=None, agent_url=None)¶
-
-class
com.vmware.vmc.model_client.AwsCloudProvider(regions=None, provider='AWS')¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
-- - - Parameters: -
-
- regions (
listofstrorNone) –
- - provider (
str) – Name of the Cloud Provider
+ - Parameters +
-
+
regions (
listofstrorNone) –
+provider (
str) – Name of the Cloud Provider
-
+
-
+
+- regions (
com.vmware.vmc.model_client.AwsCloudProvider(regions=None, provider='AWS')¶
-
-class
com.vmware.vmc.model_client.AwsCompatibleSubnets(customer_available_zones=None, vpc_map=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- customer_available_zones (
listofstrorNone) –
- - vpc_map ((
dictofstrandVpcInfoSubnets) orNone) –
+ - Parameters +
-
+
customer_available_zones (
listofstrorNone) –
+vpc_map ((
dictofstrandVpcInfoSubnets) orNone) –
-
+
+- customer_available_zones (
com.vmware.vmc.model_client.AwsCompatibleSubnets(customer_available_zones=None, vpc_map=None)¶
-
-class
com.vmware.vmc.model_client.AwsCustomerConnectedAccount(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, policy_payer_arn=None, region_to_az_to_shadow_mapping=None, org_id=None, cf_stack_name=None, state=None, account_number=None, policy_service_arn=None, policy_external_id=None, policy_payer_linked_arn=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- updated (
datetime.datetime) –
- - user_id (
str) – User id that last updated this record
- - updated_by_user_id (
str) – User id that last updated this record
- - created (
datetime.datetime) –
- - version (
long) – Version of this entity format: int32
- - updated_by_user_name (
strorNone) – User name that last updated this record
- - user_name (
str) – User name that last updated this record
- - id (
str) – Unique ID for this entity
- - policy_payer_arn (
strorNone) –
- - region_to_az_to_shadow_mapping ((
dictofstrand (dictofstrandstr)) orNone) – Provides a map of regions to availability zones from the shadow -account’s perspective
- - org_id (
strorNone) –
- - cf_stack_name (
strorNone) –
- - state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
updated (
datetime.datetime) –
+user_id (
str) – User id that last updated this record
+updated_by_user_id (
str) – User id that last updated this record
+created (
datetime.datetime) –
+version (
long) – Version of this entity format: int32
+updated_by_user_name (
strorNone) – User name that last updated this record
+user_name (
str) – User name that last updated this record
+id (
str) – Unique ID for this entity
+policy_payer_arn (
strorNone) –
+region_to_az_to_shadow_mapping ((
dictofstrand (dictofstrandstr)) orNone) – Provides a map of regions to availability zones from the shadow +account’s perspective
+org_id (
strorNone) –
+cf_stack_name (
strorNone) –
+state (
strorNone) –Possible values are:
-
-- account_number (
strorNone) –
- - policy_service_arn (
strorNone) –
- - policy_external_id (
strorNone) –
- - policy_payer_linked_arn (
strorNone) –
+
+ account_number (
strorNone) –
+policy_service_arn (
strorNone) –
+policy_external_id (
strorNone) –
+policy_payer_linked_arn (
strorNone) –
+- updated (
com.vmware.vmc.model_client.AwsCustomerConnectedAccount(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, policy_payer_arn=None, region_to_az_to_shadow_mapping=None, org_id=None, cf_stack_name=None, state=None, account_number=None, policy_service_arn=None, policy_external_id=None, policy_payer_linked_arn=None)¶
-
-class
com.vmware.vmc.model_client.AwsEsxHost(internal_public_ip_pool=None, name=None, availability_zone=None, esx_id=None, hostname=None, provider='AWS', mac_address=None, custom_properties=None, esx_state=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
-- - - Parameters: -
-
- internal_public_ip_pool (
listofSddcPublicIporNone) –
- - name (
strorNone) –
- - availability_zone (
strorNone) – Availability zone where the host is provisioned.
- - esx_id (
strorNone) –
- - hostname (
strorNone) –
- - provider (
str) –
- - mac_address (
strorNone) –
- - custom_properties ((
dictofstrandstr) orNone) –
- - esx_state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
internal_public_ip_pool (
listofSddcPublicIporNone) –
+name (
strorNone) –
+availability_zone (
strorNone) – Availability zone where the host is provisioned.
+esx_id (
strorNone) –
+hostname (
strorNone) –
+provider (
str) –
+mac_address (
strorNone) –
+custom_properties ((
dictofstrandstr) orNone) –
+esx_state (
strorNone) –Possible values are:
-
+
-
+
+- internal_public_ip_pool (
com.vmware.vmc.model_client.AwsEsxHost(internal_public_ip_pool=None, name=None, availability_zone=None, esx_id=None, hostname=None, provider='AWS', mac_address=None, custom_properties=None, esx_state=None)¶
-
-class
com.vmware.vmc.model_client.AwsKeyPair(key_name=None, key_fingerprint=None, key_material=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- key_name (
strorNone) –
- - key_fingerprint (
strorNone) –
- - key_material (
strorNone) –
+ - Parameters +
-
+
key_name (
strorNone) –
+key_fingerprint (
strorNone) –
+key_material (
strorNone) –
-
+
+- key_name (
com.vmware.vmc.model_client.AwsKeyPair(key_name=None, key_fingerprint=None, key_material=None)¶
-
-class
com.vmware.vmc.model_client.AwsKmsInfo(amazon_resource_name=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: amazon_resource_name ( -str) – The ARN associated with the customer master key for this cluster.-
+
- Parameters +
amazon_resource_name (
+str) – The ARN associated with the customer master key for this cluster.
+
com.vmware.vmc.model_client.AwsKmsInfo(amazon_resource_name=None)¶
-
-class
com.vmware.vmc.model_client.AwsSddcConfig(region=None, storage_capacity=None, name=None, account_link_sddc_config=None, vpc_cidr=None, num_hosts=None, sddc_type=None, vxlan_subnet=None, account_link_config=None, provider='AWS', skip_creating_vxlan=None, sso_domain=None, sddc_template_id=None, deployment_type=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
-- - - Parameters: -
-
- region (
str) –
- - storage_capacity (
longorNone) – The storage capacity value to be requested for the sddc primary +-
+
- Parameters +
-
+
region (
str) –
+storage_capacity (
longorNone) – The storage capacity value to be requested for the sddc primary cluster, in GiBs. If provided, instead of using the direct-attached storage, a capacity value amount of seperable storage will be used. -format: int64
-- name (
str) –
- - account_link_sddc_config (
listofAccountLinkSddcConfigorNone) – A list of the SDDC linking configurations to use.
- - vpc_cidr (
strorNone) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.
- - num_hosts (
long) –
- - sddc_type (
strorNone) – Denotes the sddc type , if the value is null or empty, the type is -considered as default.
- - vxlan_subnet (
strorNone) – VXLAN IP subnet in CIDR for compute gateway
- - account_link_config (
AccountLinkConfigorNone) – The account linking configuration, we will keep this one and remove -accountLinkSddcConfig finally.
- - provider (
str) –Possible values are:
+format: int64
+ name (
str) –
+account_link_sddc_config (
listofAccountLinkSddcConfigorNone) – A list of the SDDC linking configurations to use.
+vpc_cidr (
strorNone) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.
+num_hosts (
long) –
+sddc_type (
strorNone) – Denotes the sddc type , if the value is null or empty, the type is +considered as default.
+vxlan_subnet (
strorNone) – VXLAN IP subnet in CIDR for compute gateway
+account_link_config (
AccountLinkConfigorNone) – The account linking configuration, we will keep this one and remove +accountLinkSddcConfig finally.
+provider (
str) –Possible values are:
Determines what additional properties are available based on cloud provider.
-
-- skip_creating_vxlan (
boolorNone) – skip creating vxlan for compute gateway for SDDC provisioning
- - sso_domain (
strorNone) – The SSO domain name to use for vSphere users. If not specified, -vmc.local will be used.
- - sddc_template_id (
strorNone) – If provided, configuration from the template will applied to the -provisioned SDDC. format: UUID
- - deployment_type (
strorNone) –Possible values are:
+
+ skip_creating_vxlan (
boolorNone) – skip creating vxlan for compute gateway for SDDC provisioning
+sso_domain (
strorNone) – The SSO domain name to use for vSphere users. If not specified, +vmc.local will be used.
+sddc_template_id (
strorNone) – If provided, configuration from the template will applied to the +provisioned SDDC. format: UUID
+deployment_type (
strorNone) –Possible values are:
Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is SingleAZ.
-
+
-
+
+- region (
com.vmware.vmc.model_client.AwsSddcConfig(region=None, storage_capacity=None, name=None, account_link_sddc_config=None, vpc_cidr=None, num_hosts=None, sddc_type=None, vxlan_subnet=None, account_link_config=None, provider='AWS', skip_creating_vxlan=None, sso_domain=None, sddc_template_id=None, deployment_type=None)¶
-
-class
com.vmware.vmc.model_client.AwsSddcConnection(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, cidr_block_subnet=None, connected_account_id=None, eni_group=None, subnet_id=None, cgw_present=None, org_id=None, sddc_id=None, cidr_block_vpc=None, connection_order=None, state=None, subnet_availability_zone=None, vpc_id=None, customer_eni_infos=None, default_route_table=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- updated (
datetime.datetime) –
- - user_id (
str) – User id that last updated this record
- - updated_by_user_id (
str) – User id that last updated this record
- - created (
datetime.datetime) –
- - version (
long) – Version of this entity format: int32
- - updated_by_user_name (
strorNone) – User name that last updated this record
- - user_name (
str) – User name that last updated this record
- - id (
str) – Unique ID for this entity
- - cidr_block_subnet (
strorNone) – The CIDR block of the customer’s subnet this link is in.
- - connected_account_id (
strorNone) – The corresponding connected (customer) account UUID this connection -is attached to.
- - eni_group (
strorNone) – Which group the ENIs belongs to. (deprecated)
- - subnet_id (
strorNone) – The ID of the subnet this link is to.
- - cgw_present (
boolorNone) – Determines whether the CGW is present in this connection set or -not. Used for multi-az deployments.
- - org_id (
strorNone) – The org this link belongs to.
- - sddc_id (
strorNone) – The SDDC this link is used for.
- - cidr_block_vpc (
strorNone) – The CIDR block of the customer’s VPC.
- - connection_order (
longorNone) – The order of the connection
- - state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
updated (
datetime.datetime) –
+user_id (
str) – User id that last updated this record
+updated_by_user_id (
str) – User id that last updated this record
+created (
datetime.datetime) –
+version (
long) – Version of this entity format: int32
+updated_by_user_name (
strorNone) – User name that last updated this record
+user_name (
str) – User name that last updated this record
+id (
str) – Unique ID for this entity
+cidr_block_subnet (
strorNone) – The CIDR block of the customer’s subnet this link is in.
+connected_account_id (
strorNone) – The corresponding connected (customer) account UUID this connection +is attached to.
+eni_group (
strorNone) – Which group the ENIs belongs to. (deprecated)
+subnet_id (
strorNone) – The ID of the subnet this link is to.
+cgw_present (
boolorNone) – Determines whether the CGW is present in this connection set or +not. Used for multi-az deployments.
+org_id (
strorNone) – The org this link belongs to.
+sddc_id (
strorNone) – The SDDC this link is used for.
+cidr_block_vpc (
strorNone) – The CIDR block of the customer’s VPC.
+connection_order (
longorNone) – The order of the connection
+state (
strorNone) –Possible values are:
-
-
AwsSddcConnection.STATE_ACTIVE
-AwsSddcConnection.STATE_BROKEN
-AwsSddcConnection.STATE_DELETED
+- +
- +
-
-The state of the connection.
-- subnet_availability_zone (
strorNone) – Which availability zone is this connection in?
- - vpc_id (
strorNone) – The VPC ID of the subnet this link is to.
- - customer_eni_infos (
listofCustomerEniInfoorNone) – A list of all ENIs used for this connection.
- - default_route_table (
strorNone) – The default routing table in the customer’s VPC.
+
+The state of the connection.
+
+ subnet_availability_zone (
strorNone) – Which availability zone is this connection in?
+vpc_id (
strorNone) – The VPC ID of the subnet this link is to.
+customer_eni_infos (
listofCustomerEniInfoorNone) – A list of all ENIs used for this connection.
+default_route_table (
strorNone) – The default routing table in the customer’s VPC.
+- updated (
com.vmware.vmc.model_client.AwsSddcConnection(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, cidr_block_subnet=None, connected_account_id=None, eni_group=None, subnet_id=None, cgw_present=None, org_id=None, sddc_id=None, cidr_block_vpc=None, connection_order=None, state=None, subnet_availability_zone=None, vpc_id=None, customer_eni_infos=None, default_route_table=None)¶
-
-class
com.vmware.vmc.model_client.AwsSddcResourceConfig(backup_restore_bucket=None, public_ip_pool=None, vpc_info=None, kms_vpc_endpoint=None, max_num_public_ip=None, account_link_sddc_config=None, region=None, vsan_encryption_config=None, vpc_info_peered_agent=None, mgmt_appliance_network_name=None, nsxt=None, mgw_id=None, nsx_mgr_url=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, management_ds=None, nsx_api_public_endpoint_url=None, custom_properties=None, cloud_password=None, provider='AWS', clusters=None, vc_management_ip=None, sddc_networks=None, cloud_username=None, esx_hosts=None, nsx_mgr_management_ip=None, vc_instance_id=None, esx_cluster_id=None, vc_public_ip=None, skip_creating_vxlan=None, vc_url=None, sddc_manifest=None, vxlan_subnet=None, cloud_user_group=None, management_rp=None, witness_availability_zone=None, pop_agent_xeni_connection=None, nsx_controller_ips=None, esx_host_subnet=None, sso_domain=None, deployment_type=None, nsxt_addons=None, dns_with_management_vm_private_ip=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
-- - - Parameters: -
-
- backup_restore_bucket (
strorNone) –
- - public_ip_pool (
listofSddcPublicIporNone) –
- - vpc_info (
VpcInfoorNone) –
- - kms_vpc_endpoint (
KmsVpcEndpointorNone) –
- - max_num_public_ip (
longorNone) – maximum number of public IP that user can allocate.
- - account_link_sddc_config (
listofSddcLinkConfigorNone) –
- - region (
strorNone) –
- - vsan_encryption_config (
VsanEncryptionConfigorNone) –
- - vpc_info_peered_agent (
VpcInfoorNone) –
- - mgmt_appliance_network_name (
strorNone) – Name for management appliance network.
- - nsxt (
boolorNone) – if true, NSX-T UI is enabled.
- - mgw_id (
strorNone) – Management Gateway Id
- - nsx_mgr_url (
strorNone) – URL of the NSX Manager
- - psc_management_ip (
strorNone) – PSC internal management IP
- - psc_url (
strorNone) – URL of the PSC server
- - cgws (
listofstrorNone) –
- - availability_zones (
listofstrorNone) – Availability zones over which esx hosts are provisioned. MultiAZ +-
+
- Parameters +
-
+
backup_restore_bucket (
strorNone) –
+public_ip_pool (
listofSddcPublicIporNone) –
+vpc_info (
VpcInfoorNone) –
+kms_vpc_endpoint (
KmsVpcEndpointorNone) –
+max_num_public_ip (
longorNone) – maximum number of public IP that user can allocate.
+account_link_sddc_config (
listofSddcLinkConfigorNone) –
+region (
strorNone) –
+vsan_encryption_config (
VsanEncryptionConfigorNone) –
+vpc_info_peered_agent (
VpcInfoorNone) –
+mgmt_appliance_network_name (
strorNone) – Name for management appliance network.
+nsxt (
boolorNone) – if true, NSX-T UI is enabled.
+mgw_id (
strorNone) – Management Gateway Id
+nsx_mgr_url (
strorNone) – URL of the NSX Manager
+psc_management_ip (
strorNone) – PSC internal management IP
+psc_url (
strorNone) – URL of the PSC server
+cgws (
listofstrorNone) –
+availability_zones (
listofstrorNone) – Availability zones over which esx hosts are provisioned. MultiAZ SDDCs will have hosts provisioned over two availability zones while -SingleAZ SDDCs will provision over one.
-- management_ds (
strorNone) – The ManagedObjectReference of the management Datastore
- - nsx_api_public_endpoint_url (
strorNone) – nsx api entire base url
- - custom_properties ((
dictofstrandstr) orNone) –
- - cloud_password (
strorNone) – Password for vCenter SDDC administrator
- - provider (
str) –Possible values are:
+SingleAZ SDDCs will provision over one.
+ management_ds (
strorNone) – The ManagedObjectReference of the management Datastore
+nsx_api_public_endpoint_url (
strorNone) – nsx api entire base url
+custom_properties ((
dictofstrandstr) orNone) –
+cloud_password (
strorNone) – Password for vCenter SDDC administrator
+provider (
str) –Possible values are:
-
-Discriminator for additional properties
-- clusters (
listofvmware.vapi.struct.VapiStructorNone) – List of clusters in the SDDC. -When clients pass a value of this class as a parameter, the -attribute must contain all the attributes defined in -Cluster. When methods return a value of this class as a -return value, the attribute will contain all the attributes defined -inCluster.
- - vc_management_ip (
strorNone) – vCenter internal management IP
- - sddc_networks (
listofstrorNone) –
- - cloud_username (
strorNone) – Username for vCenter SDDC administrator
- - esx_hosts (
listofAwsEsxHostorNone) –
- - nsx_mgr_management_ip (
strorNone) – NSX Manager internal management IP
- - vc_instance_id (
strorNone) – unique id of the vCenter server
- - esx_cluster_id (
strorNone) – Cluster Id to add ESX workflow
- - vc_public_ip (
strorNone) – vCenter public IP
- - skip_creating_vxlan (
boolorNone) – skip creating vxlan for compute gateway for SDDC provisioning
- - vc_url (
strorNone) – URL of the vCenter server
- - sddc_manifest (
SddcManifestorNone) –
- - vxlan_subnet (
strorNone) – VXLAN IP subnet
- - cloud_user_group (
strorNone) – Group name for vCenter SDDC administrator
- - management_rp (
strorNone) –
- - witness_availability_zone (
strorNone) – Availability zone where the witness node is provisioned for a -MultiAZ SDDC. This is null for a SingleAZ SDDC.
- - pop_agent_xeni_connection (
PopAgentXeniConnectionorNone) –
- - nsx_controller_ips (
listofstrorNone) – List of Controller IPs
- - esx_host_subnet (
strorNone) – ESX host subnet
- - sso_domain (
strorNone) – The SSO domain name to use for vSphere users
- - deployment_type (
strorNone) –Possible values are:
++Discriminator for additional properties
+
+ clusters (
listofClusterorNone) – List of clusters in the SDDC.
+vc_management_ip (
strorNone) – vCenter internal management IP
+sddc_networks (
listofstrorNone) –
+cloud_username (
strorNone) – Username for vCenter SDDC administrator
+esx_hosts (
listofAwsEsxHostorNone) –
+nsx_mgr_management_ip (
strorNone) – NSX Manager internal management IP
+vc_instance_id (
strorNone) – unique id of the vCenter server
+esx_cluster_id (
strorNone) – Cluster Id to add ESX workflow
+vc_public_ip (
strorNone) – vCenter public IP
+skip_creating_vxlan (
boolorNone) – skip creating vxlan for compute gateway for SDDC provisioning
+vc_url (
strorNone) – URL of the vCenter server
+sddc_manifest (
SddcManifestorNone) –
+vxlan_subnet (
strorNone) – VXLAN IP subnet
+cloud_user_group (
strorNone) – Group name for vCenter SDDC administrator
+management_rp (
strorNone) –
+witness_availability_zone (
strorNone) – Availability zone where the witness node is provisioned for a +MultiAZ SDDC. This is null for a SingleAZ SDDC.
+pop_agent_xeni_connection (
PopAgentXeniConnectionorNone) –
+nsx_controller_ips (
listofstrorNone) – List of Controller IPs
+esx_host_subnet (
strorNone) – ESX host subnet
+sso_domain (
strorNone) – The SSO domain name to use for vSphere users
+deployment_type (
strorNone) –Possible values are:
-
-Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.
-- nsxt_addons (
NsxtAddonsorNone) –
- - dns_with_management_vm_private_ip (
boolorNone) – if true, use the private IP addresses to register DNS records for -the management VMs
+
+Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.
+
+ nsxt_addons (
NsxtAddonsorNone) –
+dns_with_management_vm_private_ip (
boolorNone) – if true, use the private IP addresses to register DNS records for +the management VMs
-
+
+- backup_restore_bucket (
com.vmware.vmc.model_client.AwsSddcResourceConfig(backup_restore_bucket=None, public_ip_pool=None, vpc_info=None, kms_vpc_endpoint=None, max_num_public_ip=None, account_link_sddc_config=None, region=None, vsan_encryption_config=None, vpc_info_peered_agent=None, mgmt_appliance_network_name=None, nsxt=None, mgw_id=None, nsx_mgr_url=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, management_ds=None, nsx_api_public_endpoint_url=None, custom_properties=None, cloud_password=None, provider='AWS', clusters=None, vc_management_ip=None, sddc_networks=None, cloud_username=None, esx_hosts=None, nsx_mgr_management_ip=None, vc_instance_id=None, esx_cluster_id=None, vc_public_ip=None, skip_creating_vxlan=None, vc_url=None, sddc_manifest=None, vxlan_subnet=None, cloud_user_group=None, management_rp=None, witness_availability_zone=None, pop_agent_xeni_connection=None, nsx_controller_ips=None, esx_host_subnet=None, sso_domain=None, deployment_type=None, nsxt_addons=None, dns_with_management_vm_private_ip=None)¶
-
-class
com.vmware.vmc.model_client.AwsSubnet(connected_account_id=None, region_name=None, availability_zone=None, subnet_id=None, subnet_cidr_block=None, is_compatible=None, vpc_id=None, vpc_cidr_block=None, name=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- connected_account_id (
strorNone) – The connected account ID this subnet is accessible through. This is -an internal ID formatted as a UUID specific to Skyscraper.
- - region_name (
strorNone) – The region this subnet is in, usually in the form of country code, -general location, and a number (ex. us-west-2).
- - availability_zone (
strorNone) – The availability zone this subnet is in, which should be the region -name plus one extra letter (ex. us-west-2a).
- - subnet_id (
strorNone) – The subnet ID in AWS, provided in the form ‘subnet-######’.
- - subnet_cidr_block (
strorNone) – The CIDR block of the subnet, in the form of ‘#.#.#.#/#’.
- - is_compatible (
boolorNone) – Flag indicating whether this subnet is compatible. If true, this is -a valid choice for the customer to deploy a SDDC in.
- - vpc_id (
strorNone) – The VPC ID the subnet resides in within AWS. Tends to be -‘vpc-#######’.
- - vpc_cidr_block (
strorNone) – The CIDR block of the VPC, in the form of ‘#.#.#.#/#’.
- - name (
strorNone) – Optional field (may not be provided by AWS), indicates the found -name tag for the subnet.
+ - Parameters +
-
+
connected_account_id (
strorNone) – The connected account ID this subnet is accessible through. This is +an internal ID formatted as a UUID specific to Skyscraper.
+region_name (
strorNone) – The region this subnet is in, usually in the form of country code, +general location, and a number (ex. us-west-2).
+availability_zone (
strorNone) – The availability zone this subnet is in, which should be the region +name plus one extra letter (ex. us-west-2a).
+subnet_id (
strorNone) – The subnet ID in AWS, provided in the form ‘subnet-######’.
+subnet_cidr_block (
strorNone) – The CIDR block of the subnet, in the form of ‘#.#.#.#/#’.
+is_compatible (
boolorNone) – Flag indicating whether this subnet is compatible. If true, this is +a valid choice for the customer to deploy a SDDC in.
+vpc_id (
strorNone) – The VPC ID the subnet resides in within AWS. Tends to be +‘vpc-#######’.
+vpc_cidr_block (
strorNone) – The CIDR block of the VPC, in the form of ‘#.#.#.#/#’.
+name (
strorNone) – Optional field (may not be provided by AWS), indicates the found +name tag for the subnet.
-
+
+- connected_account_id (
com.vmware.vmc.model_client.AwsSubnet(connected_account_id=None, region_name=None, availability_zone=None, subnet_id=None, subnet_cidr_block=None, is_compatible=None, vpc_id=None, vpc_cidr_block=None, name=None)¶
-
-class
com.vmware.vmc.model_client.CaCertificates(ca_certificate=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructCA certificate list. Optional.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: ca_certificate ( -listofstrorNone) –-
+
- Parameters +
ca_certificate (
+listofstrorNone) –
+
com.vmware.vmc.model_client.CaCertificates(ca_certificate=None)¶
-
-class
com.vmware.vmc.model_client.CbmStatistic(vnic=None, timestamp=None, out=None, in_=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructStatistics data for each vnic.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- vnic (
longorNone) – Vnic index. format: int32
- - timestamp (
longorNone) – Timestamp value. format: int64
- - out (
floatorNone) – Tx rate (Kilobits per second - kbps) format: double
- - in (
floatorNone) – Rx rate (Kilobits per second - kbps) format: double
+ - Parameters +
-
+
vnic (
longorNone) – Vnic index. format: int32
+timestamp (
longorNone) – Timestamp value. format: int64
+out (
floatorNone) – Tx rate (Kilobits per second - kbps) format: double
+in (
floatorNone) – Rx rate (Kilobits per second - kbps) format: double
-
+
+- vnic (
com.vmware.vmc.model_client.CbmStatistic(vnic=None, timestamp=None, out=None, in_=None)¶
-
-class
com.vmware.vmc.model_client.CbmStatistics(data_dto=None, meta_dto=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNSX Edge Interface Statistics.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- data_dto (
CbmStatsDataorNone) – Statistics data.
- - meta_dto (
MetaDashboardStatsorNone) – Start time, end time and interval details.
+ - Parameters +
-
+
data_dto (
CbmStatsDataorNone) – Statistics data.
+meta_dto (
MetaDashboardStatsorNone) – Start time, end time and interval details.
-
+
+- data_dto (
com.vmware.vmc.model_client.CbmStatistics(data_dto=None, meta_dto=None)¶
-
-class
com.vmware.vmc.model_client.CbmStatsData(vnic9=None, vnic8=None, vnic7=None, vnic6=None, vnic5=None, vnic4=None, vnic3=None, vnic2=None, vnic1=None, vnic0=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructStatistics data.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- vnic9 (
listofCbmStatisticorNone) –
- - vnic8 (
listofCbmStatisticorNone) –
- - vnic7 (
listofCbmStatisticorNone) –
- - vnic6 (
listofCbmStatisticorNone) –
- - vnic5 (
listofCbmStatisticorNone) –
- - vnic4 (
listofCbmStatisticorNone) –
- - vnic3 (
listofCbmStatisticorNone) –
- - vnic2 (
listofCbmStatisticorNone) –
- - vnic1 (
listofCbmStatisticorNone) –
- - vnic0 (
listofCbmStatisticorNone) –
+ - Parameters +
-
+
vnic9 (
listofCbmStatisticorNone) –
+vnic8 (
listofCbmStatisticorNone) –
+vnic7 (
listofCbmStatisticorNone) –
+vnic6 (
listofCbmStatisticorNone) –
+vnic5 (
listofCbmStatisticorNone) –
+vnic4 (
listofCbmStatisticorNone) –
+vnic3 (
listofCbmStatisticorNone) –
+vnic2 (
listofCbmStatisticorNone) –
+vnic1 (
listofCbmStatisticorNone) –
+vnic0 (
listofCbmStatisticorNone) –
-
+
+- vnic9 (
com.vmware.vmc.model_client.CbmStatsData(vnic9=None, vnic8=None, vnic7=None, vnic6=None, vnic5=None, vnic4=None, vnic3=None, vnic2=None, vnic1=None, vnic0=None)¶
-
-class
com.vmware.vmc.model_client.CloudProvider(provider='CloudProvider')¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
-- - - Parameters: provider ( -str) – Name of the Cloud Provider-
+
- Parameters +
provider (
+str) – Name of the Cloud Provider
+-
-class
com.vmware.vmc.model_client.Cluster(esx_host_list=None, cluster_state=None, aws_kms_info=None, host_cpu_cores_count=None, cluster_id='Cluster', cluster_name=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- esx_host_list (
listofAwsEsxHostorNone) –
- - cluster_state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
esx_host_list (
listofAwsEsxHostorNone) –
+cluster_state (
strorNone) –Possible values are:
-
-- aws_kms_info (
AwsKmsInfoorNone) – AWS Key Management Service information associated with this cluster
- - host_cpu_cores_count (
longorNone) – Number of cores enabled on ESX hosts added to this cluster format: -int32
- - cluster_id (
str) –
- - cluster_name (
strorNone) –
+
+ aws_kms_info (
AwsKmsInfoorNone) – AWS Key Management Service information associated with this cluster
+host_cpu_cores_count (
longorNone) – Number of cores enabled on ESX hosts added to this cluster format: +int32
+cluster_id (
str) –
+cluster_name (
strorNone) –
+- esx_host_list (
-
-
cluster_id¶
- Return the discriminator value
-
-
+
com.vmware.vmc.model_client.Cluster(esx_host_list=None, cluster_state=None, aws_kms_info=None, host_cpu_cores_count=None, cluster_id=None, cluster_name=None)¶-
-
com.vmware.vmc.model_client.CloudProvider(provider='CloudProvider')¶
-
-class
com.vmware.vmc.model_client.ClusterConfig(host_cpu_cores_count=None, storage_capacity=None, num_hosts=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- host_cpu_cores_count (
longorNone) – Customize CPU cores on hosts in a cluster. Specify number of cores -to be enabled on hosts in a cluster. format: int32
- - storage_capacity (
longorNone) – For EBS-backed instances only, the requested storage capacity in -GiB. format: int64
- - num_hosts (
long) –
+ - Parameters +
-
+
host_cpu_cores_count (
longorNone) – Customize CPU cores on hosts in a cluster. Specify number of cores +to be enabled on hosts in a cluster. format: int32
+storage_capacity (
longorNone) – For EBS-backed instances only, the requested storage capacity in +GiB. format: int64
+num_hosts (
long) –
-
+
+- host_cpu_cores_count (
com.vmware.vmc.model_client.ClusterConfig(host_cpu_cores_count=None, storage_capacity=None, num_hosts=None)¶
-
-class
com.vmware.vmc.model_client.ComputeGatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, logical_networks=None, nat_rules=None, l2_vpn=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- public_ip (
SddcPublicIporNone) –
- - primary_dns (
strorNone) –
- - secondary_dns (
strorNone) –
- - firewall_rules (
listofFirewallRuleorNone) –
- - vpns (
listofVpnorNone) –
- - logical_networks (
listofLogicalNetworkorNone) –
- - nat_rules (
listofNatRuleorNone) –
- - l2_vpn (
vmware.vapi.struct.VapiStructorNone) –
+ - Parameters +
-
+
public_ip (
SddcPublicIporNone) –
+primary_dns (
strorNone) –
+secondary_dns (
strorNone) –
+firewall_rules (
listofFirewallRuleorNone) –
+vpns (
listofVpnorNone) –
+logical_networks (
listofLogicalNetworkorNone) –
+nat_rules (
listofNatRuleorNone) –
+l2_vpn (
vmware.vapi.struct.VapiStructorNone) –
-
+
+- public_ip (
com.vmware.vmc.model_client.ComputeGatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, logical_networks=None, nat_rules=None, l2_vpn=None)¶
-
-class
com.vmware.vmc.model_client.ConnectivityAgentValidation(source=None, type=None, ports=None, path=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- source (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
source (
strorNone) –Possible values are:
-
-
ConnectivityAgentValidation.SOURCE_VCENTER
-ConnectivityAgentValidation.SOURCE_SRM
-ConnectivityAgentValidation.SOURCE_VR
+- +
- +
-
-source appliance of connectivity test, i.e. VCENTER, SRM, VR.
-- type (
strorNone) –Possible values are:
++source appliance of connectivity test, i.e. VCENTER, SRM, VR.
+
+ type (
strorNone) –Possible values are:
-
-
ConnectivityAgentValidation.TYPE_PING
-ConnectivityAgentValidation.TYPE_TRACEROUTE
-ConnectivityAgentValidation.TYPE_DNS
-ConnectivityAgentValidation.TYPE_CONNECTIVITY
-ConnectivityAgentValidation.TYPE_CURL
+- +
- +
- +
- +
type of connectivity test, i.e. PING, TRACEROUTE, DNS, CONNECTIVITY, CURL. For CONNECTIVITY and CURL tests only, please specify the ports to be tested against.
-
-- ports (
listofstrorNone) – TCP ports ONLY for CONNECTIVITY and CURL tests.
- - path (
strorNone) – URL path ONLY for CURL tests.
+
+ ports (
listofstrorNone) – TCP ports ONLY for CONNECTIVITY and CURL tests.
+path (
strorNone) – URL path ONLY for CURL tests.
+- source (
com.vmware.vmc.model_client.ConnectivityAgentValidation(source=None, type=None, ports=None, path=None)¶
-
-class
com.vmware.vmc.model_client.ConnectivityValidationGroup(id=None, name=None, sub_groups=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- id (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
id (
strorNone) –Possible values are:
-
-test group id, currently, only HLM.
-- name (
strorNone) – Name of the test group.
- - sub_groups (
listofConnectivityValidationSubGrouporNone) – List of sub groups.
+
+test group id, currently, only HLM.
+
+ name (
strorNone) – Name of the test group.
+sub_groups (
listofConnectivityValidationSubGrouporNone) – List of sub groups.
+- id (
com.vmware.vmc.model_client.ConnectivityValidationGroup(id=None, name=None, sub_groups=None)¶
-
-class
com.vmware.vmc.model_client.ConnectivityValidationGroups(groups=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: groups ( -listofConnectivityValidationGrouporNone) – List of groups.-
+
- Parameters +
groups (
+listofConnectivityValidationGrouporNone) – List of groups.
+
com.vmware.vmc.model_client.ConnectivityValidationGroups(groups=None)¶
-
-class
com.vmware.vmc.model_client.ConnectivityValidationInput(id=None, value=None, label=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- id (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
id (
strorNone) –Possible values are:
-
-
ConnectivityValidationInput.ID_HOSTNAME
-ConnectivityValidationInput.ID_HOST_IP
-ConnectivityValidationInput.ID_HOSTNAME_OR_IP
+- +
- +
input value type, i.e. HOSTNAME_OR_IP, HOST_IP, HOSTNAME. Accept FQDN or IP address as input value when id = HOSTNAME_OR_IP, accept FQDN ONLY when id = HOSTNAME, accept IP address ONLY when id = HOST_IP.
-
-- value (
strorNone) – the FQDN or IP address to run the test against, use #primary-dns -or #secondary-dns as the on-prem primary/secondary DNS server IP.
- - label (
strorNone) – (Optional, for UI display only) input value label.
+
+ value (
strorNone) – the FQDN or IP address to run the test against, use #primary-dns +or #secondary-dns as the on-prem primary/secondary DNS server IP.
+label (
strorNone) – (Optional, for UI display only) input value label.
+- id (
com.vmware.vmc.model_client.ConnectivityValidationInput(id=None, value=None, label=None)¶
-
-class
com.vmware.vmc.model_client.ConnectivityValidationSubGroup(inputs=None, tests=None, label=None, help=None, id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- inputs (
listofConnectivityValidationInputorNone) – List of user inputs for the sub group.
- - tests (
listofConnectivityAgentValidationorNone) – List of connectivity tests.
- - label (
strorNone) – Name of the sub-group.
- - help (
strorNone) – Help text.
- - id (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
inputs (
listofConnectivityValidationInputorNone) – List of user inputs for the sub group.
+tests (
listofConnectivityAgentValidationorNone) – List of connectivity tests.
+label (
strorNone) – Name of the sub-group.
+help (
strorNone) – Help text.
+id (
strorNone) –Possible values are:
-
-
ConnectivityValidationSubGroup.ID_PRIMARY_DNS
-ConnectivityValidationSubGroup.ID_SECONDARY_DNS
-ConnectivityValidationSubGroup.ID_ONPREM_VCENTER
-ConnectivityValidationSubGroup.ID_ONPREM_PSC
-ConnectivityValidationSubGroup.ID_ACTIVE_DIRECTORY
-ConnectivityValidationSubGroup.ID_ONPREM_ESX
-ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VCENTER
-ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_PSC
-ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_SRM
-ConnectivityValidationSubGroup.ID_DRAAS_ONPREM_VR
+- +
- +
- +
- +
- +
- +
- +
- +
- +
subGroup id, i.e. PRIMARY_DNS, SECONDARY_DNS, ONPREM_VCENTER, ONPREM_PSC, ACTIVE_DIRECTORY, ONPREM_ESX, DRAAS_ONPREM_VCENTER, DRAAS_ONPREM_PSC, DRAAS_ONPREM_SRM and DRAAS_ONPREM_VR.
-
+
+- inputs (
com.vmware.vmc.model_client.ConnectivityValidationSubGroup(inputs=None, tests=None, label=None, help=None, id=None)¶
-
-
ID_DRAAS_ONPREM_VCENTER= 'DRAAS_ONPREM_VCENTER'¶
+
ID_DRAAS_ONPREM_VCENTER = 'DRAAS_ONPREM_VCENTER'¶
-
-class
com.vmware.vmc.model_client.CrlCertificates(crl_certificate=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructCRL certificate list. Optional.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: crl_certificate ( -listofstrorNone) –-
+
- Parameters +
crl_certificate (
+listofstrorNone) –
+
com.vmware.vmc.model_client.CrlCertificates(crl_certificate=None)¶
-
-class
com.vmware.vmc.model_client.CustomerEniInfo(secondary_ip_addresses=None, eni_id=None, primary_ip_address=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructIndicates a single cross-account ENI and its characteristics.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- secondary_ip_addresses (
listofstrorNone) – Indicates list of secondary IP created for this ENI.
- - eni_id (
strorNone) – Interface ID on customer account.
- - primary_ip_address (
strorNone) – Indicates primary address of the ENI.
+ - Parameters +
-
+
secondary_ip_addresses (
listofstrorNone) – Indicates list of secondary IP created for this ENI.
+eni_id (
strorNone) – Interface ID on customer account.
+primary_ip_address (
strorNone) – Indicates primary address of the ENI.
-
+
+- secondary_ip_addresses (
com.vmware.vmc.model_client.CustomerEniInfo(secondary_ip_addresses=None, eni_id=None, primary_ip_address=None)¶
-
-class
com.vmware.vmc.model_client.DashboardData(firewall=None, sslvpn=None, interfaces=None, load_balancer=None, ipsec=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDashboard Statistics data.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- firewall (
FirewallDashboardStatsorNone) – NSX Edge Firewall Statistics data.
- - sslvpn (
SslvpnDashboardStatsorNone) – NSX Edge SSL VPN Statistics data.
- - interfaces (
InterfacesDashboardStatsorNone) – NSX Edge Interface Statistics data.
- - load_balancer (
LoadBalancerDashboardStatsorNone) – NSX Edge Load Balancer Statistics data.
- - ipsec (
IpsecDashboardStatsorNone) – NSX Edge Ipsec Statistics data.
+ - Parameters +
-
+
firewall (
FirewallDashboardStatsorNone) – NSX Edge Firewall Statistics data.
+sslvpn (
SslvpnDashboardStatsorNone) – NSX Edge SSL VPN Statistics data.
+interfaces (
InterfacesDashboardStatsorNone) – NSX Edge Interface Statistics data.
+load_balancer (
LoadBalancerDashboardStatsorNone) – NSX Edge Load Balancer Statistics data.
+ipsec (
IpsecDashboardStatsorNone) – NSX Edge Ipsec Statistics data.
-
+
+- firewall (
com.vmware.vmc.model_client.DashboardData(firewall=None, sslvpn=None, interfaces=None, load_balancer=None, ipsec=None)¶
-
-class
com.vmware.vmc.model_client.DashboardStat(timestamp=None, value=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- timestamp (
longorNone) –
- - value (
floatorNone) –
+ - Parameters +
-
+
timestamp (
longorNone) –
+value (
floatorNone) –
-
+
+- timestamp (
com.vmware.vmc.model_client.DashboardStat(timestamp=None, value=None)¶
-
-class
com.vmware.vmc.model_client.DashboardStatistics(data_dto=None, meta_dto=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDashboard Statistics data.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- data_dto (
DashboardDataorNone) – Dashboard Statistics data.
- - meta_dto (
MetaDashboardStatsorNone) – Start time, end time and interval details.
+ - Parameters +
-
+
data_dto (
DashboardDataorNone) – Dashboard Statistics data.
+meta_dto (
MetaDashboardStatsorNone) – Start time, end time and interval details.
-
+
+- data_dto (
com.vmware.vmc.model_client.DashboardStatistics(data_dto=None, meta_dto=None)¶
-
-class
com.vmware.vmc.model_client.DataPageEdgeSummary(paging_info=None, data=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- paging_info (
PagingInfoorNone) –
- - data (
listofEdgeSummaryorNone) –
+ - Parameters +
-
+
paging_info (
PagingInfoorNone) –
+data (
listofEdgeSummaryorNone) –
-
+
+- paging_info (
com.vmware.vmc.model_client.DataPageEdgeSummary(paging_info=None, data=None)¶
-
-class
com.vmware.vmc.model_client.DataPageSddcNetwork(paging_info=None, data=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- paging_info (
PagingInfoorNone) –
- - data (
listofSddcNetworkorNone) –
+ - Parameters +
-
+
paging_info (
PagingInfoorNone) –
+data (
listofSddcNetworkorNone) –
-
+
+- paging_info (
com.vmware.vmc.model_client.DataPageSddcNetwork(paging_info=None, data=None)¶
-
-class
com.vmware.vmc.model_client.DataPermissions(save_permission=None, publish_permission=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- save_permission (
boolorNone) –
- - publish_permission (
boolorNone) –
+ - Parameters +
-
+
save_permission (
boolorNone) –
+publish_permission (
boolorNone) –
-
+
+- save_permission (
com.vmware.vmc.model_client.DataPermissions(save_permission=None, publish_permission=None)¶
-
-class
com.vmware.vmc.model_client.DhcpLeaseInfo(host_lease_info_dtos=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDHCP lease information.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: host_lease_info_dtos ( -listofHostLeaseInfoorNone) – List of DHCP leases.-
+
- Parameters +
host_lease_info_dtos (
+listofHostLeaseInfoorNone) – List of DHCP leases.
+
com.vmware.vmc.model_client.DhcpLeaseInfo(host_lease_info_dtos=None)¶
-
-class
com.vmware.vmc.model_client.DhcpLeases(time_stamp=None, host_lease_infos_dto=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDHCP leases information
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- time_stamp (
longorNone) – The timestamp of the DHCP lease. format: int64
- - host_lease_infos_dto (
DhcpLeaseInfoorNone) – DHCP lease information.
+ - Parameters +
-
+
time_stamp (
longorNone) – The timestamp of the DHCP lease. format: int64
+host_lease_infos_dto (
DhcpLeaseInfoorNone) – DHCP lease information.
-
+
+- time_stamp (
com.vmware.vmc.model_client.DhcpLeases(time_stamp=None, host_lease_infos_dto=None)¶
-
-class
com.vmware.vmc.model_client.DnsConfig(feature_type=None, logging=None, enabled=None, dns_views=None, listeners=None, version=None, template=None, cache_size=None, dns_servers=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDNS configuration
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- feature_type (
strorNone) –
- - logging (
LoggingorNone) – DNS logging setting.
- - enabled (
boolorNone) – Value is true if feature is enabled. Default value is true. -Optional.
- - dns_views (
DnsViewsorNone) – List of DNS views.
- - listeners (
DnsListenersorNone) – List of DNS listeners.
- - version (
longorNone) – Version number tracking each configuration change. To avoid +-
+
- Parameters +
-
+
feature_type (
strorNone) –
+logging (
LoggingorNone) – DNS logging setting.
+enabled (
boolorNone) – Value is true if feature is enabled. Default value is true. +Optional.
+dns_views (
DnsViewsorNone) – List of DNS views.
+listeners (
DnsListenersorNone) – List of DNS listeners.
+version (
longorNone) – Version number tracking each configuration change. To avoid problems with overwriting changes, always retrieve and modify the latest configuration to include the current version number in your request. If you provide a version number which is not current, the request is rejected. If you omit the version number, the request is accepted but may overwrite any current changes if your change is -not in sync with the latest change. format: int64
-- template (
strorNone) –
- - cache_size (
longorNone) – The cache size of the DNS service. format: int64
- - dns_servers (
IpAddressesorNone) –
+not in sync with the latest change. format: int64
+ template (
strorNone) –
+cache_size (
longorNone) – The cache size of the DNS service. format: int64
+dns_servers (
IpAddressesorNone) –
+- feature_type (
com.vmware.vmc.model_client.DnsConfig(feature_type=None, logging=None, enabled=None, dns_views=None, listeners=None, version=None, template=None, cache_size=None, dns_servers=None)¶
-
-class
com.vmware.vmc.model_client.DnsForwarders(ip_address=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDNS forwarders.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: ip_address ( -listofstrorNone) – IP addresses of the DNS servers.-
+
- Parameters +
ip_address (
+listofstrorNone) – IP addresses of the DNS servers.
+
com.vmware.vmc.model_client.DnsForwarders(ip_address=None)¶
-
-class
com.vmware.vmc.model_client.DnsListeners(ip_address=None, vnic=None, type=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- ip_address (
listofstrorNone) – List of IP addresses.
- - vnic (
listofstrorNone) – Vnic for DNS listener.
- - type (
strorNone) –
+ - Parameters +
-
+
ip_address (
listofstrorNone) – List of IP addresses.
+vnic (
listofstrorNone) – Vnic for DNS listener.
+type (
strorNone) –
-
+
+- ip_address (
com.vmware.vmc.model_client.DnsListeners(ip_address=None, vnic=None, type=None)¶
-
-class
com.vmware.vmc.model_client.DnsResponseStats(total=None, form_err=None, nx_domain=None, success=None, server_fail=None, nxrrset=None, others=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDNS response statistics.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- total (
longorNone) –
- - form_err (
longorNone) –
- - nx_domain (
longorNone) –
- - success (
longorNone) –
- - server_fail (
longorNone) –
- - nxrrset (
longorNone) –
- - others (
longorNone) –
+ - Parameters +
-
+
total (
longorNone) –
+form_err (
longorNone) –
+nx_domain (
longorNone) –
+success (
longorNone) –
+server_fail (
longorNone) –
+nxrrset (
longorNone) –
+others (
longorNone) –
-
+
+- total (
com.vmware.vmc.model_client.DnsResponseStats(total=None, form_err=None, nx_domain=None, success=None, server_fail=None, nxrrset=None, others=None)¶
-
-class
com.vmware.vmc.model_client.DnsStatusAndStats(time_stamp=None, requests=None, responses=None, cached_dbrr_set=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDNS statistics.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- time_stamp (
longorNone) –
- - requests (
RequestsorNone) –
- - responses (
DnsResponseStatsorNone) –
- - cached_dbrr_set (
longorNone) –
+ - Parameters +
-
+
time_stamp (
longorNone) –
+requests (
RequestsorNone) –
+responses (
DnsResponseStatsorNone) –
+cached_dbrr_set (
longorNone) –
-
+
+- time_stamp (
com.vmware.vmc.model_client.DnsStatusAndStats(time_stamp=None, requests=None, responses=None, cached_dbrr_set=None)¶
-
-class
com.vmware.vmc.model_client.DnsView(name=None, view_match=None, recursion=None, view_id=None, forwarders=None, enabled=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDNS View
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- name (
str) – Name of the DNS view.
- - view_match (
DnsViewMatchorNone) – Rules that match the DNS query to this view. The rule can be -ipAddress, or ipSet. Defaults to ipAddress ‘any’ and ‘any’ vnic.
- - recursion (
boolorNone) – Recursion enabled on DNS view.
- - view_id (
strorNone) – Identifier for the DNS view.
- - forwarders (
DnsForwardersorNone) – DNS forwarders.
- - enabled (
boolorNone) – DNS view is enabled.
+ - Parameters +
-
+
name (
str) – Name of the DNS view.
+view_match (
DnsViewMatchorNone) – Rules that match the DNS query to this view. The rule can be +ipAddress, or ipSet. Defaults to ipAddress ‘any’ and ‘any’ vnic.
+recursion (
boolorNone) – Recursion enabled on DNS view.
+view_id (
strorNone) – Identifier for the DNS view.
+forwarders (
DnsForwardersorNone) – DNS forwarders.
+enabled (
boolorNone) – DNS view is enabled.
-
+
+- name (
com.vmware.vmc.model_client.DnsView(name=None, view_match=None, recursion=None, view_id=None, forwarders=None, enabled=None)¶
-
-class
com.vmware.vmc.model_client.DnsViewMatch(vnic=None, ip_set=None, ip_address=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDns view match
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- vnic (
listofstrorNone) –
- - ip_set (
listofstrorNone) –
- - ip_address (
listofstrorNone) –
+ - Parameters +
-
+
vnic (
listofstrorNone) –
+ip_set (
listofstrorNone) –
+ip_address (
listofstrorNone) –
-
+
+- vnic (
com.vmware.vmc.model_client.DnsViewMatch(vnic=None, ip_set=None, ip_address=None)¶
-
-class
com.vmware.vmc.model_client.DnsViews(dns_view=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDNS views.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: dns_view ( -listofDnsVieworNone) – List of DNS views.-
+
- Parameters +
dns_view (
+listofDnsVieworNone) – List of DNS views.
+
com.vmware.vmc.model_client.DnsViews(dns_view=None)¶
-
-class
com.vmware.vmc.model_client.EdgeJob(status=None, edge_id=None, module=None, job_id=None, error_code=None, result=None, start_time=None, message=None, end_time=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructJob status information for the configuration change carried out on NSX Edge.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- status (
strorNone) – Job status.
- - edge_id (
strorNone) – NSX Edge ID.
- - module (
strorNone) – Module information.
- - job_id (
strorNone) – Job ID.
- - error_code (
strorNone) – Error code identifying the failure of the configuration change.
- - result (
listofResultorNone) – Job result information.
- - start_time (
datetime.datetimeorNone) – Job start time. format: date-time
- - message (
strorNone) – Job message.
- - end_time (
datetime.datetimeorNone) – Job end time. format: date-time
+ - Parameters +
-
+
status (
strorNone) – Job status.
+edge_id (
strorNone) – NSX Edge ID.
+module (
strorNone) – Module information.
+job_id (
strorNone) – Job ID.
+error_code (
strorNone) – Error code identifying the failure of the configuration change.
+result (
listofResultorNone) – Job result information.
+start_time (
datetime.datetimeorNone) – Job start time. format: date-time
+message (
strorNone) – Job message.
+end_time (
datetime.datetimeorNone) – Job end time. format: date-time
-
+
+- status (
com.vmware.vmc.model_client.EdgeJob(status=None, edge_id=None, module=None, job_id=None, error_code=None, result=None, start_time=None, message=None, end_time=None)¶
-
-class
com.vmware.vmc.model_client.EdgeStatus(pre_rules_exists=None, feature_statuses=None, timestamp=None, publish_status=None, last_published_pre_rules_generation_number=None, version=None, edge_vm_status=None, active_vse_ha_index=None, system_status=None, ha_vnic_in_use=None, edge_status=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNSX Edge Appliance status.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- pre_rules_exists (
boolorNone) – Value is true if pre rules publish is enabled.
- - feature_statuses (
listofFeatureStatusorNone) – Individual feature status.
- - timestamp (
longorNone) – Timestamp value at which the NSX Edge healthcheck was done. format: -int64
- - publish_status (
strorNone) – Status of the latest configuration change for the NSX Edge. Values -are APPLIED or PERSISTED (not published to NSX Edge Appliance yet).
- - last_published_pre_rules_generation_number (
longorNone) – Value of the last published pre rules generation number. format: -int64
- - version (
longorNone) – Version number of the current configuration. format: int64
- - edge_vm_status (
listofEdgeVmStatusorNone) – Detailed status of each of the deployed NSX Edge appliances.
- - active_vse_ha_index (
longorNone) – Index of the active NSX Edge appliance. Values are 0 and 1. format: -int32
- - system_status (
strorNone) – System status of the active NSX Edge appliance.
- - ha_vnic_in_use (
longorNone) – Index of the vnic consumed for NSX Edge HA. format: int32
- - edge_status (
strorNone) – NSX Edge appliance health status identified by GREY (unknown +-
+
- Parameters +
-
+
pre_rules_exists (
boolorNone) – Value is true if pre rules publish is enabled.
+feature_statuses (
listofFeatureStatusorNone) – Individual feature status.
+timestamp (
longorNone) – Timestamp value at which the NSX Edge healthcheck was done. format: +int64
+publish_status (
strorNone) – Status of the latest configuration change for the NSX Edge. Values +are APPLIED or PERSISTED (not published to NSX Edge Appliance yet).
+last_published_pre_rules_generation_number (
longorNone) – Value of the last published pre rules generation number. format: +int64
+version (
longorNone) – Version number of the current configuration. format: int64
+edge_vm_status (
listofEdgeVmStatusorNone) – Detailed status of each of the deployed NSX Edge appliances.
+active_vse_ha_index (
longorNone) – Index of the active NSX Edge appliance. Values are 0 and 1. format: +int32
+system_status (
strorNone) – System status of the active NSX Edge appliance.
+ha_vnic_in_use (
longorNone) – Index of the vnic consumed for NSX Edge HA. format: int32
+edge_status (
strorNone) – NSX Edge appliance health status identified by GREY (unknown status), GREEN (health checks are successful), YELLOW (intermittent health check failure), RED (none of the appliances are in serving state). If health check fails for 5 consecutive times for all appliance (2 for HA else 1) then status will turn from YELLOW to -RED.
+RED.
+- pre_rules_exists (
com.vmware.vmc.model_client.EdgeStatus(pre_rules_exists=None, feature_statuses=None, timestamp=None, publish_status=None, last_published_pre_rules_generation_number=None, version=None, edge_vm_status=None, active_vse_ha_index=None, system_status=None, ha_vnic_in_use=None, edge_status=None)¶
-
-class
com.vmware.vmc.model_client.EdgeSummary(feature_capabilities=None, edge_type=None, logical_router_scopes=None, recent_job_info=None, hypervisor_assist=None, edge_assist_id=None, edge_status=None, edge_assist_instance_name=None, object_id=None, node_id=None, id=None, datacenter_name=None, state=None, client_handle=None, scope=None, type=None, revision=None, vsm_uuid=None, description=None, extended_attributes=None, local_egress_enabled=None, universal_revision=None, allowed_actions=None, object_type_name=None, is_upgrade_available=None, is_universal=None, name=None, lrouter_uuid=None, appliances_summary=None, api_version=None, tenant_id=None, datacenter_moid=None, number_of_connected_vnics=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNSX Edge summary. Read only.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- feature_capabilities (
FeatureCapabilitiesorNone) – List of Features and their capability details based on Edge -appliance form factor.
- - edge_type (
strorNone) – NSX Edge type, whether ‘gatewayServices’ or ‘distributedRouter’.
- - logical_router_scopes (
LogicalRouterScopesorNone) – Backing type scope (DistributedVirtualSwitch - VLAN, TransportZone --VXLAN) and its ID for the Distributed Logical Router.
- - recent_job_info (
EdgeJoborNone) – Job information for the most recent configuration change carried -out on the NSX Edge.
- - hypervisor_assist (
boolorNone) –
- - edge_assist_id (
longorNone) – ID generated by NSX Manager for Distributed Logical Router only. -format: int64
- - edge_status (
strorNone) – NSX Edge appliance health status identified by GREY (unknown +-
+
- Parameters +
-
+
feature_capabilities (
FeatureCapabilitiesorNone) – List of Features and their capability details based on Edge +appliance form factor.
+edge_type (
strorNone) – NSX Edge type, whether ‘gatewayServices’ or ‘distributedRouter’.
+logical_router_scopes (
LogicalRouterScopesorNone) – Backing type scope (DistributedVirtualSwitch - VLAN, TransportZone +-VXLAN) and its ID for the Distributed Logical Router.
+recent_job_info (
EdgeJoborNone) – Job information for the most recent configuration change carried +out on the NSX Edge.
+hypervisor_assist (
boolorNone) –
+edge_assist_id (
longorNone) – ID generated by NSX Manager for Distributed Logical Router only. +format: int64
+edge_status (
strorNone) – NSX Edge appliance health status identified by GREY (unknown status), GREEN (health checks are successful), YELLOW (intermittent health check failure), RED (none of the appliances are in serving state). If health check fails for 5 consecutive times for all appliance (2 for HA else 1) then status will turn from YELLOW to -RED.
-- edge_assist_instance_name (
strorNone) – Name derived by NSX Manager only for Distributed Logical Router.
- - object_id (
strorNone) –
- - node_id (
strorNone) –
- - id (
strorNone) – NSX Edge ID.
- - datacenter_name (
strorNone) – Datacenter name where the NSX Edge is deployed.
- - state (
strorNone) – Deployment state of the NSX Edge appliance. Values are ‘deployed’ +RED.
+ edge_assist_instance_name (
strorNone) – Name derived by NSX Manager only for Distributed Logical Router.
+object_id (
strorNone) –
+node_id (
strorNone) –
+id (
strorNone) – NSX Edge ID.
+datacenter_name (
strorNone) – Datacenter name where the NSX Edge is deployed.
+state (
strorNone) – Deployment state of the NSX Edge appliance. Values are ‘deployed’ when VMs have been deployed, ‘undeployed’ when no VMs are deployed and ‘active’ when Edge type is Distributed Logical Router and has -no appliance deployed but is serving data path.
-- client_handle (
strorNone) –
- - scope (
ScopeInfoorNone) –
- - type (
ObjectTypeorNone) –
- - revision (
longorNone) –
- - vsm_uuid (
strorNone) –
- - description (
strorNone) –
- - extended_attributes (
listofExtendedAttributeorNone) –
- - local_egress_enabled (
boolorNone) – Value is true if local egress is enabled for UDLR traffic. -Applicable only for Universal Distributed Logical Router.
- - universal_revision (
longorNone) –
- - allowed_actions (
listofstrorNone) –
- - object_type_name (
strorNone) –
- - is_upgrade_available (
boolorNone) – Value is true if NSX Edge upgrade is available.
- - is_universal (
boolorNone) –
- - name (
strorNone) –
- - lrouter_uuid (
strorNone) – Distributed Logical Router UUID provided by the NSX Controller.
- - appliances_summary (
AppliancesSummaryorNone) – NSX Edge appliance summary.
- - api_version (
strorNone) – REST API version applicable for the NSX Edge.
- - tenant_id (
strorNone) – Tenant ID for the NSX Edge.
- - datacenter_moid (
strorNone) – vCenter MOID of the datacenter where the NSX Edge is deployed.
- - number_of_connected_vnics (
longorNone) – Number of connected vnics that are configured on the NSX Edge. -format: int32
+no appliance deployed but is serving data path.
+ client_handle (
strorNone) –
+scope (
ScopeInfoorNone) –
+type (
ObjectTypeorNone) –
+revision (
longorNone) –
+vsm_uuid (
strorNone) –
+description (
strorNone) –
+extended_attributes (
listofExtendedAttributeorNone) –
+local_egress_enabled (
boolorNone) – Value is true if local egress is enabled for UDLR traffic. +Applicable only for Universal Distributed Logical Router.
+universal_revision (
longorNone) –
+allowed_actions (
listofstrorNone) –
+object_type_name (
strorNone) –
+is_upgrade_available (
boolorNone) – Value is true if NSX Edge upgrade is available.
+is_universal (
boolorNone) –
+name (
strorNone) –
+lrouter_uuid (
strorNone) – Distributed Logical Router UUID provided by the NSX Controller.
+appliances_summary (
AppliancesSummaryorNone) – NSX Edge appliance summary.
+api_version (
strorNone) – REST API version applicable for the NSX Edge.
+tenant_id (
strorNone) – Tenant ID for the NSX Edge.
+datacenter_moid (
strorNone) – vCenter MOID of the datacenter where the NSX Edge is deployed.
+number_of_connected_vnics (
longorNone) – Number of connected vnics that are configured on the NSX Edge. +format: int32
+- feature_capabilities (
com.vmware.vmc.model_client.EdgeSummary(feature_capabilities=None, edge_type=None, logical_router_scopes=None, recent_job_info=None, hypervisor_assist=None, edge_assist_id=None, edge_status=None, edge_assist_instance_name=None, object_id=None, node_id=None, id=None, datacenter_name=None, state=None, client_handle=None, scope=None, type=None, revision=None, vsm_uuid=None, description=None, extended_attributes=None, local_egress_enabled=None, universal_revision=None, allowed_actions=None, object_type_name=None, is_upgrade_available=None, is_universal=None, name=None, lrouter_uuid=None, appliances_summary=None, api_version=None, tenant_id=None, datacenter_moid=None, number_of_connected_vnics=None)¶
-
-class
com.vmware.vmc.model_client.EdgeVmStatus(index=None, ha_state=None, name=None, id=None, edge_vm_status=None, pre_rules_generation_number=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructStatus of each of the deployed NSX Edge appliances.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- index (
longorNone) – High Availability index of the appliance. Values are 0 and 1. -format: int32
- - ha_state (
strorNone) – High Availability state of the appliance. Values are active and -standby.
- - name (
strorNone) – Name of the NSX Edge appliance.
- - id (
strorNone) – vCenter MOID of the NSX Edge appliance.
- - edge_vm_status (
strorNone) – NSX Edge appliance health status identified by GREY (unknown +-
+
- Parameters +
-
+
index (
longorNone) – High Availability index of the appliance. Values are 0 and 1. +format: int32
+ha_state (
strorNone) – High Availability state of the appliance. Values are active and +standby.
+name (
strorNone) – Name of the NSX Edge appliance.
+id (
strorNone) – vCenter MOID of the NSX Edge appliance.
+edge_vm_status (
strorNone) – NSX Edge appliance health status identified by GREY (unknown status), GREEN (health checks are successful), YELLOW (intermittent -health check failure), RED (appliance not in serving state).
-- pre_rules_generation_number (
longorNone) – Value of the last published pre rules generation number. format: -int64
+health check failure), RED (appliance not in serving state).
+ pre_rules_generation_number (
longorNone) – Value of the last published pre rules generation number. format: +int64
+- index (
com.vmware.vmc.model_client.EdgeVmStatus(index=None, ha_state=None, name=None, id=None, edge_vm_status=None, pre_rules_generation_number=None)¶
-
-class
com.vmware.vmc.model_client.EdgeVnicAddressGroup(subnet_prefix_length=None, secondary_addresses=None, primary_address=None, subnet_mask=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructAddress group configuration of the NSX Edge vnic. An interface can have one primary and multiple secondary IP addresses.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- subnet_prefix_length (
strorNone) – Subnet prefix length of the primary IP address.
- - secondary_addresses (
SecondaryAddressesorNone) – Secondary IP addresses of the NSX Edge vnic address group. -Optional.
- - primary_address (
strorNone) – Primary IP address of the vnic interface. Required.
- - subnet_mask (
strorNone) –
+ - Parameters +
-
+
subnet_prefix_length (
strorNone) – Subnet prefix length of the primary IP address.
+secondary_addresses (
SecondaryAddressesorNone) – Secondary IP addresses of the NSX Edge vnic address group. +Optional.
+primary_address (
strorNone) – Primary IP address of the vnic interface. Required.
+subnet_mask (
strorNone) –
-
+
+- subnet_prefix_length (
com.vmware.vmc.model_client.EdgeVnicAddressGroup(subnet_prefix_length=None, secondary_addresses=None, primary_address=None, subnet_mask=None)¶
-
-class
com.vmware.vmc.model_client.EdgeVnicAddressGroups(address_groups=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNSX Edge vnic address group configuration details.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: address_groups ( -listofEdgeVnicAddressGrouporNone) – Address group configuration of the NSX Edge vnic. Vnic can be -configured to have more than one address group/subnets.-
+
- Parameters +
address_groups (
+listofEdgeVnicAddressGrouporNone) – Address group configuration of the NSX Edge vnic. Vnic can be +configured to have more than one address group/subnets.
+
com.vmware.vmc.model_client.EdgeVnicAddressGroups(address_groups=None)¶
-
-class
com.vmware.vmc.model_client.EniInfo(subnet_id=None, id=None, security_group_id=None, private_ip=None, mac_address=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- subnet_id (
strorNone) – Subnet it belongs to.
- - id (
strorNone) – Interface ID.
- - security_group_id (
strorNone) – Security Group of Eni.
- - private_ip (
strorNone) – Private ip of eni.
- - mac_address (
strorNone) – Mac address of nic.
+ - Parameters +
-
+
subnet_id (
strorNone) – Subnet it belongs to.
+id (
strorNone) – Interface ID.
+security_group_id (
strorNone) – Security Group of Eni.
+private_ip (
strorNone) – Private ip of eni.
+mac_address (
strorNone) – Mac address of nic.
-
+
+- subnet_id (
com.vmware.vmc.model_client.EniInfo(subnet_id=None, id=None, security_group_id=None, private_ip=None, mac_address=None)¶
-
-class
com.vmware.vmc.model_client.ErrorResponse(status=None, path=None, retryable=None, error_code=None, error_messages=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- status (
long) – HTTP status code
- - path (
str) – Originating request URI
- - retryable (
bool) – If true, client should retry operation
- - error_code (
str) – unique error code
- - error_messages (
listofstr) – localized error messages
+ - Parameters +
-
+
status (
long) – HTTP status code
+path (
str) – Originating request URI
+retryable (
bool) – If true, client should retry operation
+error_code (
str) – unique error code
+error_messages (
listofstr) – localized error messages
-
+
+- status (
com.vmware.vmc.model_client.ErrorResponse(status=None, path=None, retryable=None, error_code=None, error_messages=None)¶
-
-class
com.vmware.vmc.model_client.EsxConfig(availability_zone=None, esxs=None, cluster_id=None, num_hosts=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- availability_zone (
strorNone) – Availability zone where the hosts should be provisioned. (Can be -specified only for privileged host operations).
- - esxs (
listofstrorNone) –
- - cluster_id (
strorNone) – An optional cluster id if the esxs operation has to be on a -specific cluster.
- - num_hosts (
long) –
+ - Parameters +
-
+
availability_zone (
strorNone) – Availability zone where the hosts should be provisioned. (Can be +specified only for privileged host operations).
+esxs (
listofstrorNone) –
+cluster_id (
strorNone) – An optional cluster id if the esxs operation has to be on a +specific cluster.
+num_hosts (
long) –
-
+
+- availability_zone (
com.vmware.vmc.model_client.EsxConfig(availability_zone=None, esxs=None, cluster_id=None, num_hosts=None)¶
-
-class
com.vmware.vmc.model_client.EsxHost(name=None, availability_zone=None, esx_id=None, hostname=None, provider='EsxHost', mac_address=None, custom_properties=None, esx_state=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- name (
strorNone) –
- - availability_zone (
strorNone) – Availability zone where the host is provisioned.
- - esx_id (
strorNone) –
- - hostname (
strorNone) –
- - provider (
str) –
- - mac_address (
strorNone) –
- - custom_properties ((
dictofstrandstr) orNone) –
- - esx_state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
name (
strorNone) –
+availability_zone (
strorNone) – Availability zone where the host is provisioned.
+esx_id (
strorNone) –
+hostname (
strorNone) –
+provider (
str) –
+mac_address (
strorNone) –
+custom_properties ((
dictofstrandstr) orNone) –
+esx_state (
strorNone) –Possible values are:
-
+
+- name (
com.vmware.vmc.model_client.EsxHost(name=None, availability_zone=None, esx_id=None, hostname=None, provider='EsxHost', mac_address=None, custom_properties=None, esx_state=None)¶
-
+
@@ -2400,1939 +2166,1704 @@ names.
-
-class
com.vmware.vmc.model_client.ExtendedAttribute(name=None, value=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- name (
strorNone) –
- - value (
strorNone) –
+ - Parameters +
-
+
name (
strorNone) –
+value (
strorNone) –
-
+
+- name (
com.vmware.vmc.model_client.ExtendedAttribute(name=None, value=None)¶
-
-class
com.vmware.vmc.model_client.FeatureCapabilities(timestamp=None, feature_capabilities=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructList of features and their capability details based on NSX Edge appliance form factor.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- timestamp (
longorNone) – Time stamp value at which the feature capabilities were retrieved. -format: int64
- - feature_capabilities (
listofFeatureCapabilityorNone) – List of feature capability information.
+ - Parameters +
-
+
timestamp (
longorNone) – Time stamp value at which the feature capabilities were retrieved. +format: int64
+feature_capabilities (
listofFeatureCapabilityorNone) – List of feature capability information.
-
+
+- timestamp (
com.vmware.vmc.model_client.FeatureCapabilities(timestamp=None, feature_capabilities=None)¶
-
-class
com.vmware.vmc.model_client.FeatureCapability(configuration_limits=None, is_supported=None, service=None, permission=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructFeature capability information.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- configuration_limits (
listofKeyValueAttributesorNone) – List of key value pairs describing the feature configuration -limits.
- - is_supported (
boolorNone) – Value is true if feature is supported on NSX Edge.
- - service (
strorNone) – Name of the feature or service.
- - permission (
LicenceAclPermissionsorNone) – Licence and access control information for the feature.
+ - Parameters +
-
+
configuration_limits (
listofKeyValueAttributesorNone) – List of key value pairs describing the feature configuration +limits.
+is_supported (
boolorNone) – Value is true if feature is supported on NSX Edge.
+service (
strorNone) – Name of the feature or service.
+permission (
LicenceAclPermissionsorNone) – Licence and access control information for the feature.
-
+
+- configuration_limits (
com.vmware.vmc.model_client.FeatureCapability(configuration_limits=None, is_supported=None, service=None, permission=None)¶
-
-class
com.vmware.vmc.model_client.FeatureStatus(status=None, configured=None, server_status=None, publish_status=None, service=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructIndividual feature status.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- status (
strorNone) – Status of the feature or service.
- - configured (
boolorNone) – Value is true if feature is configured.
- - server_status (
strorNone) – Server status of the feature or service. Values are up and down.
- - publish_status (
strorNone) – Publish status of the feature, whether APPLIED or PERSISTED.
- - service (
strorNone) – Name of the feature or service.
+ - Parameters +
-
+
status (
strorNone) – Status of the feature or service.
+configured (
boolorNone) – Value is true if feature is configured.
+server_status (
strorNone) – Server status of the feature or service. Values are up and down.
+publish_status (
strorNone) – Publish status of the feature, whether APPLIED or PERSISTED.
+service (
strorNone) – Name of the feature or service.
-
+
+- status (
com.vmware.vmc.model_client.FeatureStatus(status=None, configured=None, server_status=None, publish_status=None, service=None)¶
-
-class
com.vmware.vmc.model_client.FirewallConfig(firewall_rules=None, feature_type=None, version=None, template=None, global_config=None, enabled=None, default_policy=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructFirewall Configuration
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- firewall_rules (
FirewallRulesorNone) – Ordered list of firewall rules.
- - feature_type (
strorNone) –
- - version (
longorNone) – Version number tracking each configuration change. To avoid +-
+
- Parameters +
-
+
firewall_rules (
FirewallRulesorNone) – Ordered list of firewall rules.
+feature_type (
strorNone) –
+version (
longorNone) – Version number tracking each configuration change. To avoid problems with overwriting changes, always retrieve and modify the latest configuration to include the current version number in your request. If you provide a version number which is not current, the request is rejected. If you omit the version number, the request is accepted but may overwrite any current changes if your change is -not in sync with the latest change. format: int64
-- template (
strorNone) –
- - global_config (
FirewallGlobalConfigorNone) – Global configuration applicable to all rules.
- - enabled (
boolorNone) – Value is true if feature is enabled. Default value is true. -Optional.
- - default_policy (
FirewallDefaultPolicyorNone) – Default Policy.
+not in sync with the latest change. format: int64
+ template (
strorNone) –
+global_config (
FirewallGlobalConfigorNone) – Global configuration applicable to all rules.
+enabled (
boolorNone) – Value is true if feature is enabled. Default value is true. +Optional.
+default_policy (
FirewallDefaultPolicyorNone) – Default Policy.
+- firewall_rules (
com.vmware.vmc.model_client.FirewallConfig(firewall_rules=None, feature_type=None, version=None, template=None, global_config=None, enabled=None, default_policy=None)¶
-
-class
com.vmware.vmc.model_client.FirewallDashboardStats(connections=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDashboard Statistics data for Firewall.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: connections ( -listofDashboardStatorNone) – Number of NSX Edge firewall connections and rules.-
+
- Parameters +
connections (
+listofDashboardStatorNone) – Number of NSX Edge firewall connections and rules.
+
com.vmware.vmc.model_client.FirewallDashboardStats(connections=None)¶
-
-class
com.vmware.vmc.model_client.FirewallDefaultPolicy(action=None, logging_enabled=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructFirewall default policy. Default is deny.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- action (
strorNone) – Action. Default is deny. Supported values accept, deny
- - logging_enabled (
boolorNone) – Enable logging for the rule.
+ - Parameters +
-
+
action (
strorNone) – Action. Default is deny. Supported values accept, deny
+logging_enabled (
boolorNone) – Enable logging for the rule.
-
+
+- action (
com.vmware.vmc.model_client.FirewallDefaultPolicy(action=None, logging_enabled=None)¶
-
-class
com.vmware.vmc.model_client.FirewallGlobalConfig(tcp_allow_out_of_window_packets=None, udp_timeout=None, ip_generic_timeout=None, tcp_pick_ongoing_connections=None, tcp_timeout_open=None, tcp_timeout_close=None, icmp6_timeout=None, drop_icmp_replays=None, log_icmp_errors=None, tcp_send_reset_for_closed_vse_ports=None, drop_invalid_traffic=None, enable_syn_flood_protection=None, icmp_timeout=None, tcp_timeout_established=None, log_invalid_traffic=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructGlobal configuration applicable to all rules.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- tcp_allow_out_of_window_packets (
boolorNone) – Allow TCP out of window packets.
- - udp_timeout (
longorNone) – UDP timeout close. format: int32
- - ip_generic_timeout (
longorNone) – IP generic timeout. format: int32
- - tcp_pick_ongoing_connections (
boolorNone) – Pick TCP ongoing connections.
- - tcp_timeout_open (
longorNone) – TCP timeout open. format: int32
- - tcp_timeout_close (
longorNone) – TCP timeout close. format: int32
- - icmp6_timeout (
longorNone) – ICMP6 timeout. format: int32
- - drop_icmp_replays (
boolorNone) – Drop icmp replays.
- - log_icmp_errors (
boolorNone) – Log icmp errors.
- - tcp_send_reset_for_closed_vse_ports (
boolorNone) – Send TCP reset for closed NSX Edge ports.
- - drop_invalid_traffic (
boolorNone) – Drop invalid traffic.
- - enable_syn_flood_protection (
boolorNone) – Protect against SYN flood attacks by detecting bogus TCP +-
+
- Parameters +
-
+
tcp_allow_out_of_window_packets (
boolorNone) – Allow TCP out of window packets.
+udp_timeout (
longorNone) – UDP timeout close. format: int32
+ip_generic_timeout (
longorNone) – IP generic timeout. format: int32
+tcp_pick_ongoing_connections (
boolorNone) – Pick TCP ongoing connections.
+tcp_timeout_open (
longorNone) – TCP timeout open. format: int32
+tcp_timeout_close (
longorNone) – TCP timeout close. format: int32
+icmp6_timeout (
longorNone) – ICMP6 timeout. format: int32
+drop_icmp_replays (
boolorNone) – Drop icmp replays.
+log_icmp_errors (
boolorNone) – Log icmp errors.
+tcp_send_reset_for_closed_vse_ports (
boolorNone) – Send TCP reset for closed NSX Edge ports.
+drop_invalid_traffic (
boolorNone) – Drop invalid traffic.
+enable_syn_flood_protection (
boolorNone) – Protect against SYN flood attacks by detecting bogus TCP connections and terminating them without consuming firewall state -tracking resources. Default : false
-- icmp_timeout (
longorNone) – ICMP timeout. format: int32
- - tcp_timeout_established (
longorNone) – TCP timeout established. format: int32
- - log_invalid_traffic (
boolorNone) – Log invalid traffic.
+tracking resources. Default : false
+ icmp_timeout (
longorNone) – ICMP timeout. format: int32
+tcp_timeout_established (
longorNone) – TCP timeout established. format: int32
+log_invalid_traffic (
boolorNone) – Log invalid traffic.
+- tcp_allow_out_of_window_packets (
com.vmware.vmc.model_client.FirewallGlobalConfig(tcp_allow_out_of_window_packets=None, udp_timeout=None, ip_generic_timeout=None, tcp_pick_ongoing_connections=None, tcp_timeout_open=None, tcp_timeout_close=None, icmp6_timeout=None, drop_icmp_replays=None, log_icmp_errors=None, tcp_send_reset_for_closed_vse_ports=None, drop_invalid_traffic=None, enable_syn_flood_protection=None, icmp_timeout=None, tcp_timeout_established=None, log_invalid_traffic=None)¶
-
-class
com.vmware.vmc.model_client.FirewallRule(rule_type=None, application_ids=None, name=None, rule_interface=None, destination=None, id=None, destination_scope=None, source=None, source_scope=None, services=None, action=None, revision=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- rule_type (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
rule_type (
strorNone) –Possible values are:
-
-- application_ids (
listofstrorNone) –
- - name (
strorNone) –
- - rule_interface (
strorNone) – Deprecated, left for backwards compatibility. Remove once UI stops -using it.
- - destination (
strorNone) – Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated -list of those entries. If not specified, defaults to ‘any’.
- - id (
strorNone) –
- - destination_scope (
FirewallRuleScopeorNone) –
- - source (
strorNone) – Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated -list of those entries. If not specified, defaults to ‘any’.
- - source_scope (
FirewallRuleScopeorNone) –
- - services (
listofFirewallServiceorNone) – list of protocols and ports for this firewall rule
- - action (
strorNone) –Possible values are:
+
+ application_ids (
listofstrorNone) –
+name (
strorNone) –
+rule_interface (
strorNone) – Deprecated, left for backwards compatibility. Remove once UI stops +using it.
+destination (
strorNone) – Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated +list of those entries. If not specified, defaults to ‘any’.
+id (
strorNone) –
+destination_scope (
FirewallRuleScopeorNone) –
+source (
strorNone) – Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated +list of those entries. If not specified, defaults to ‘any’.
+source_scope (
FirewallRuleScopeorNone) –
+services (
listofFirewallServiceorNone) – list of protocols and ports for this firewall rule
+action (
strorNone) –Possible values are:
-
-- revision (
longorNone) – current revision of the list of firewall rules, used to protect +
+ revision (
longorNone) – current revision of the list of firewall rules, used to protect against concurrent modification (first writer wins) format: int32 This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.
+it is present in a request to server it will be ignored.
+- rule_type (
com.vmware.vmc.model_client.FirewallRule(rule_type=None, application_ids=None, name=None, rule_interface=None, destination=None, id=None, destination_scope=None, source=None, source_scope=None, services=None, action=None, revision=None)¶
-
-class
com.vmware.vmc.model_client.FirewallRuleScope(grouping_object_ids=None, vnic_group_ids=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructOptional for FirewallRule. If not specified, defaults to ‘any’.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- grouping_object_ids (
listofstrorNone) –
- - vnic_group_ids (
listofstrorNone) –Possible values are:
+-
+
- Parameters +
-
+
grouping_object_ids (
listofstrorNone) –
+vnic_group_ids (
listofstrorNone) –Possible values are:
-
-
FirewallRuleScope.VNIC_GROUP_IDS_VSE
-FirewallRuleScope.VNIC_GROUP_IDS_INTERNAL
-FirewallRuleScope.VNIC_GROUP_IDS_EXTERNAL
-FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_0
-FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_1
-FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_2
-FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_3
-FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_4
-FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_5
-FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_6
-FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_7
-FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_8
-FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_9
+- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
+
+- grouping_object_ids (
com.vmware.vmc.model_client.FirewallRuleScope(grouping_object_ids=None, vnic_group_ids=None)¶
-
-class
com.vmware.vmc.model_client.FirewallRuleStats(timestamp=None, connection_count=None, byte_count=None, packet_count=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructStatistics for firewall rule
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- timestamp (
longorNone) – Timestamp of statistics collection. format: int64
- - connection_count (
longorNone) – Connection count. format: int64
- - byte_count (
longorNone) – Byte count. format: int64
- - packet_count (
longorNone) – Packet count. format: int64
+ - Parameters +
-
+
timestamp (
longorNone) – Timestamp of statistics collection. format: int64
+connection_count (
longorNone) – Connection count. format: int64
+byte_count (
longorNone) – Byte count. format: int64
+packet_count (
longorNone) – Packet count. format: int64
-
+
+- timestamp (
com.vmware.vmc.model_client.FirewallRuleStats(timestamp=None, connection_count=None, byte_count=None, packet_count=None)¶
-
-class
com.vmware.vmc.model_client.FirewallRules(firewall_rules=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructOrdered list of firewall rules.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: firewall_rules ( -listofNsxfirewallruleorNone) – Ordered list of firewall rules.-
+
- Parameters +
firewall_rules (
+listofNsxfirewallruleorNone) – Ordered list of firewall rules.
+
com.vmware.vmc.model_client.FirewallRules(firewall_rules=None)¶
-
-class
com.vmware.vmc.model_client.FirewallService(protocol=None, ports=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- protocol (
strorNone) – protocol name, such as ‘tcp’, ‘udp’ etc.
- - ports (
listofstrorNone) – a list of port numbers and port ranges, such as {80, 91-95, 99}. If -not specified, defaults to ‘any’.
+ - Parameters +
-
+
protocol (
strorNone) – protocol name, such as ‘tcp’, ‘udp’ etc.
+ports (
listofstrorNone) – a list of port numbers and port ranges, such as {80, 91-95, 99}. If +not specified, defaults to ‘any’.
-
+
+- protocol (
com.vmware.vmc.model_client.FirewallService(protocol=None, ports=None)¶
-
-class
com.vmware.vmc.model_client.GatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDescribes common properties for MGW and CGW configuration templates
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- public_ip (
SddcPublicIporNone) –
- - primary_dns (
strorNone) –
- - secondary_dns (
strorNone) –
- - firewall_rules (
listofFirewallRuleorNone) –
- - vpns (
listofVpnorNone) –
+ - Parameters +
-
+
public_ip (
SddcPublicIporNone) –
+primary_dns (
strorNone) –
+secondary_dns (
strorNone) –
+firewall_rules (
listofFirewallRuleorNone) –
+vpns (
listofVpnorNone) –
-
+
+- public_ip (
com.vmware.vmc.model_client.GatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None)¶
-
-class
com.vmware.vmc.model_client.GlcmBundle(s3_bucket=None, id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructthe GlcmBundle used for deploying the sddc
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- s3_bucket (
strorNone) – the glcmbundle’s s3 bucket
- - id (
strorNone) – the glcmbundle’s id
+ - Parameters +
-
+
s3_bucket (
strorNone) – the glcmbundle’s s3 bucket
+id (
strorNone) – the glcmbundle’s id
-
+
+- s3_bucket (
com.vmware.vmc.model_client.GlcmBundle(s3_bucket=None, id=None)¶
-
-class
com.vmware.vmc.model_client.HostLeaseInfo(mac_address=None, ends=None, abandoned=None, cltt=None, client_hostname=None, starts=None, binding_state=None, hardware_type=None, tsfp=None, uid=None, next_binding_state=None, ip_address=None, tstp=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDHCP lease information.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- mac_address (
strorNone) – MAC address of the client.
- - ends (
strorNone) – End time of the lease.
- - abandoned (
strorNone) – Time stamp of when IP address was marked as abandoned.
- - cltt (
strorNone) – Client Last Transaction Time of the lease info.
- - client_hostname (
strorNone) – Name of the client.
- - starts (
strorNone) – Start time of the lease.
- - binding_state (
strorNone) – Lease’s binding state.
- - hardware_type (
strorNone) – The hardware type on which the lease will be used.
- - tsfp (
strorNone) – Time Sent From Partner of the lease info.
- - uid (
strorNone) – Uid to identify the DHCP lease.
- - next_binding_state (
strorNone) – Indicates what state the lease will move to when the current state -expires.
- - ip_address (
strorNone) – IP address of the client.
- - tstp (
strorNone) – Time Sent To Partner of the lease info.
+ - Parameters +
-
+
mac_address (
strorNone) – MAC address of the client.
+ends (
strorNone) – End time of the lease.
+abandoned (
strorNone) – Time stamp of when IP address was marked as abandoned.
+cltt (
strorNone) – Client Last Transaction Time of the lease info.
+client_hostname (
strorNone) – Name of the client.
+starts (
strorNone) – Start time of the lease.
+binding_state (
strorNone) – Lease’s binding state.
+hardware_type (
strorNone) – The hardware type on which the lease will be used.
+tsfp (
strorNone) – Time Sent From Partner of the lease info.
+uid (
strorNone) – Uid to identify the DHCP lease.
+next_binding_state (
strorNone) – Indicates what state the lease will move to when the current state +expires.
+ip_address (
strorNone) – IP address of the client.
+tstp (
strorNone) – Time Sent To Partner of the lease info.
-
+
+- mac_address (
com.vmware.vmc.model_client.HostLeaseInfo(mac_address=None, ends=None, abandoned=None, cltt=None, client_hostname=None, starts=None, binding_state=None, hardware_type=None, tsfp=None, uid=None, next_binding_state=None, ip_address=None, tstp=None)¶
-
-class
com.vmware.vmc.model_client.InteractionPermissions(manage_permission=None, view_permission=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- manage_permission (
boolorNone) –
- - view_permission (
boolorNone) –
+ - Parameters +
-
+
manage_permission (
boolorNone) –
+view_permission (
boolorNone) –
-
+
+- manage_permission (
com.vmware.vmc.model_client.InteractionPermissions(manage_permission=None, view_permission=None)¶
-
-class
com.vmware.vmc.model_client.InterfacesDashboardStats(vnic7_in_pkt=None, vnic0_in_byte=None, vnic8_out_pkt=None, vnic5_in_byte=None, vnic2_in_pkt=None, vnic3_in_pkt=None, vnic6_out_byte=None, vnic3_in_byte=None, vnic8_in_pkt=None, vnic1_in_byte=None, vnic1_out_pkt=None, vnic5_out_byte=None, vnic0_out_pkt=None, vnic0_out_byte=None, vnic6_out_pkt=None, vnic3_out_byte=None, vnic7_in_byte=None, vnic1_out_byte=None, vnic9_out_pkt=None, vnic9_in_pkt=None, vnic4_in_byte=None, vnic5_out_pkt=None, vnic2_out_pkt=None, vnic2_in_byte=None, vnic5_in_pkt=None, vnic7_out_pkt=None, vnic3_out_pkt=None, vnic4_out_pkt=None, vnic4_out_byte=None, vnic1_in_pkt=None, vnic2_out_byte=None, vnic6_in_byte=None, vnic0_in_pkt=None, vnic9_in_byte=None, vnic7_out_byte=None, vnic4_in_pkt=None, vnic9_out_byte=None, vnic8_out_byte=None, vnic8_in_byte=None, vnic6_in_pkt=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDashboard Statistics data for Interfaces.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- vnic7_in_pkt (
listofDashboardStatorNone) –
- - vnic0_in_byte (
listofDashboardStatorNone) –
- - vnic8_out_pkt (
listofDashboardStatorNone) –
- - vnic5_in_byte (
listofDashboardStatorNone) –
- - vnic2_in_pkt (
listofDashboardStatorNone) –
- - vnic3_in_pkt (
listofDashboardStatorNone) –
- - vnic6_out_byte (
listofDashboardStatorNone) –
- - vnic3_in_byte (
listofDashboardStatorNone) –
- - vnic8_in_pkt (
listofDashboardStatorNone) –
- - vnic1_in_byte (
listofDashboardStatorNone) –
- - vnic1_out_pkt (
listofDashboardStatorNone) –
- - vnic5_out_byte (
listofDashboardStatorNone) –
- - vnic0_out_pkt (
listofDashboardStatorNone) –
- - vnic0_out_byte (
listofDashboardStatorNone) –
- - vnic6_out_pkt (
listofDashboardStatorNone) –
- - vnic3_out_byte (
listofDashboardStatorNone) –
- - vnic7_in_byte (
listofDashboardStatorNone) –
- - vnic1_out_byte (
listofDashboardStatorNone) –
- - vnic9_out_pkt (
listofDashboardStatorNone) –
- - vnic9_in_pkt (
listofDashboardStatorNone) –
- - vnic4_in_byte (
listofDashboardStatorNone) –
- - vnic5_out_pkt (
listofDashboardStatorNone) –
- - vnic2_out_pkt (
listofDashboardStatorNone) –
- - vnic2_in_byte (
listofDashboardStatorNone) –
- - vnic5_in_pkt (
listofDashboardStatorNone) –
- - vnic7_out_pkt (
listofDashboardStatorNone) –
- - vnic3_out_pkt (
listofDashboardStatorNone) –
- - vnic4_out_pkt (
listofDashboardStatorNone) –
- - vnic4_out_byte (
listofDashboardStatorNone) –
- - vnic1_in_pkt (
listofDashboardStatorNone) –
- - vnic2_out_byte (
listofDashboardStatorNone) –
- - vnic6_in_byte (
listofDashboardStatorNone) –
- - vnic0_in_pkt (
listofDashboardStatorNone) –
- - vnic9_in_byte (
listofDashboardStatorNone) –
- - vnic7_out_byte (
listofDashboardStatorNone) –
- - vnic4_in_pkt (
listofDashboardStatorNone) –
- - vnic9_out_byte (
listofDashboardStatorNone) –
- - vnic8_out_byte (
listofDashboardStatorNone) –
- - vnic8_in_byte (
listofDashboardStatorNone) –
- - vnic6_in_pkt (
listofDashboardStatorNone) –
+ - Parameters +
-
+
vnic7_in_pkt (
listofDashboardStatorNone) –
+vnic0_in_byte (
listofDashboardStatorNone) –
+vnic8_out_pkt (
listofDashboardStatorNone) –
+vnic5_in_byte (
listofDashboardStatorNone) –
+vnic2_in_pkt (
listofDashboardStatorNone) –
+vnic3_in_pkt (
listofDashboardStatorNone) –
+vnic6_out_byte (
listofDashboardStatorNone) –
+vnic3_in_byte (
listofDashboardStatorNone) –
+vnic8_in_pkt (
listofDashboardStatorNone) –
+vnic1_in_byte (
listofDashboardStatorNone) –
+vnic1_out_pkt (
listofDashboardStatorNone) –
+vnic5_out_byte (
listofDashboardStatorNone) –
+vnic0_out_pkt (
listofDashboardStatorNone) –
+vnic0_out_byte (
listofDashboardStatorNone) –
+vnic6_out_pkt (
listofDashboardStatorNone) –
+vnic3_out_byte (
listofDashboardStatorNone) –
+vnic7_in_byte (
listofDashboardStatorNone) –
+vnic1_out_byte (
listofDashboardStatorNone) –
+vnic9_out_pkt (
listofDashboardStatorNone) –
+vnic9_in_pkt (
listofDashboardStatorNone) –
+vnic4_in_byte (
listofDashboardStatorNone) –
+vnic5_out_pkt (
listofDashboardStatorNone) –
+vnic2_out_pkt (
listofDashboardStatorNone) –
+vnic2_in_byte (
listofDashboardStatorNone) –
+vnic5_in_pkt (
listofDashboardStatorNone) –
+vnic7_out_pkt (
listofDashboardStatorNone) –
+vnic3_out_pkt (
listofDashboardStatorNone) –
+vnic4_out_pkt (
listofDashboardStatorNone) –
+vnic4_out_byte (
listofDashboardStatorNone) –
+vnic1_in_pkt (
listofDashboardStatorNone) –
+vnic2_out_byte (
listofDashboardStatorNone) –
+vnic6_in_byte (
listofDashboardStatorNone) –
+vnic0_in_pkt (
listofDashboardStatorNone) –
+vnic9_in_byte (
listofDashboardStatorNone) –
+vnic7_out_byte (
listofDashboardStatorNone) –
+vnic4_in_pkt (
listofDashboardStatorNone) –
+vnic9_out_byte (
listofDashboardStatorNone) –
+vnic8_out_byte (
listofDashboardStatorNone) –
+vnic8_in_byte (
listofDashboardStatorNone) –
+vnic6_in_pkt (
listofDashboardStatorNone) –
-
+
+- vnic7_in_pkt (
com.vmware.vmc.model_client.InterfacesDashboardStats(vnic7_in_pkt=None, vnic0_in_byte=None, vnic8_out_pkt=None, vnic5_in_byte=None, vnic2_in_pkt=None, vnic3_in_pkt=None, vnic6_out_byte=None, vnic3_in_byte=None, vnic8_in_pkt=None, vnic1_in_byte=None, vnic1_out_pkt=None, vnic5_out_byte=None, vnic0_out_pkt=None, vnic0_out_byte=None, vnic6_out_pkt=None, vnic3_out_byte=None, vnic7_in_byte=None, vnic1_out_byte=None, vnic9_out_pkt=None, vnic9_in_pkt=None, vnic4_in_byte=None, vnic5_out_pkt=None, vnic2_out_pkt=None, vnic2_in_byte=None, vnic5_in_pkt=None, vnic7_out_pkt=None, vnic3_out_pkt=None, vnic4_out_pkt=None, vnic4_out_byte=None, vnic1_in_pkt=None, vnic2_out_byte=None, vnic6_in_byte=None, vnic0_in_pkt=None, vnic9_in_byte=None, vnic7_out_byte=None, vnic4_in_pkt=None, vnic9_out_byte=None, vnic8_out_byte=None, vnic8_in_byte=None, vnic6_in_pkt=None)¶
-
-class
com.vmware.vmc.model_client.IpAddresses(ip_address=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructIP address
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: ip_address ( -listofstrorNone) – List of IP addresses.-
+
- Parameters +
ip_address (
+listofstrorNone) – List of IP addresses.
+
com.vmware.vmc.model_client.IpAddresses(ip_address=None)¶
-
-class
com.vmware.vmc.model_client.Ipsec(feature_type=None, logging=None, global_=None, enabled=None, sites=None, disable_event=None, version=None, template=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNSX Edge IPsec configuration details.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- feature_type (
strorNone) –
- - logging (
LoggingorNone) – Configure logging for the feature on NSX Edge appliance. Logging is -disabled by default. Optional.
- - global (
IpsecGlobalConfigorNone) – IPsec Global configuration details.
- - enabled (
boolorNone) – Value is true if feature is enabled. Default value is true. -Optional.
- - sites (
IpsecSitesorNone) – IPsec Site configuration details.
- - disable_event (
boolorNone) – Enable/disable event generation on NSX Edge appliance for IPsec.
- - version (
longorNone) – Version number tracking each configuration change. To avoid +-
+
- Parameters +
-
+
feature_type (
strorNone) –
+logging (
LoggingorNone) – Configure logging for the feature on NSX Edge appliance. Logging is +disabled by default. Optional.
+global (
IpsecGlobalConfigorNone) – IPsec Global configuration details.
+enabled (
boolorNone) – Value is true if feature is enabled. Default value is true. +Optional.
+sites (
IpsecSitesorNone) – IPsec Site configuration details.
+disable_event (
boolorNone) – Enable/disable event generation on NSX Edge appliance for IPsec.
+version (
longorNone) – Version number tracking each configuration change. To avoid problems with overwriting changes, always retrieve and modify the latest configuration to include the current version number in your request. If you provide a version number which is not current, the request is rejected. If you omit the version number, the request is accepted but may overwrite any current changes if your change is -not in sync with the latest change. format: int64
-- template (
strorNone) –
+not in sync with the latest change. format: int64
+ template (
strorNone) –
+- feature_type (
com.vmware.vmc.model_client.Ipsec(feature_type=None, logging=None, global_=None, enabled=None, sites=None, disable_event=None, version=None, template=None)¶
-
-class
com.vmware.vmc.model_client.IpsecDashboardStats(ipsec_bytes_out=None, ipsec_bytes_in=None, ipsec_tunnels=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDashboard Statistics data for Ipsec.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- ipsec_bytes_out (
listofDashboardStatorNone) – Tx transmitted bytes.
- - ipsec_bytes_in (
listofDashboardStatorNone) – Rx received bytes.
- - ipsec_tunnels (
listofDashboardStatorNone) – Number of Ipsec tunnels.
+ - Parameters +
-
+
ipsec_bytes_out (
listofDashboardStatorNone) – Tx transmitted bytes.
+ipsec_bytes_in (
listofDashboardStatorNone) – Rx received bytes.
+ipsec_tunnels (
listofDashboardStatorNone) – Number of Ipsec tunnels.
-
+
+- ipsec_bytes_out (
com.vmware.vmc.model_client.IpsecDashboardStats(ipsec_bytes_out=None, ipsec_bytes_in=None, ipsec_tunnels=None)¶
-
-class
com.vmware.vmc.model_client.IpsecGlobalConfig(psk=None, ca_certificates=None, service_certificate=None, crl_certificates=None, extension=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructIPsec Global configuration details.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- psk (
strorNone) – IPsec Global Pre Shared Key. Maximum characters is 128. Required +-
+
- Parameters +
-
+
psk (
strorNone) – IPsec Global Pre Shared Key. Maximum characters is 128. Required when peerIp is configured as ‘any’ in NSX Edge IPsec Site -configuration.
-- ca_certificates (
CaCertificatesorNone) – CA certificate list. Optional.
- - service_certificate (
strorNone) – Certificate name or identifier. Required when x.509 is selected as -the authentication mode.
- - crl_certificates (
CrlCertificatesorNone) – CRL certificate list. Optional.
- - extension (
strorNone) –
+configuration.
+ ca_certificates (
CaCertificatesorNone) – CA certificate list. Optional.
+service_certificate (
strorNone) – Certificate name or identifier. Required when x.509 is selected as +the authentication mode.
+crl_certificates (
CrlCertificatesorNone) – CRL certificate list. Optional.
+extension (
strorNone) –
+- psk (
com.vmware.vmc.model_client.IpsecGlobalConfig(psk=None, ca_certificates=None, service_certificate=None, crl_certificates=None, extension=None)¶
-
-class
com.vmware.vmc.model_client.IpsecSite(psk=None, local_id=None, enable_pfs=None, authentication_mode=None, peer_subnets=None, dh_group=None, site_id=None, description=None, peer_ip=None, name=None, certificate=None, local_ip=None, encryption_algorithm=None, enabled=None, mtu=None, extension=None, peer_id=None, local_subnets=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNSX Edge IPsec Site configuration details.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- psk (
strorNone) – Pre Shared Key for the IPsec Site. Required if Site peerIp is not +-
+
- Parameters +
-
+
psk (
strorNone) – Pre Shared Key for the IPsec Site. Required if Site peerIp is not ‘any’. Global PSK is used when Authentication mode is PSK and Site -peerIp is ‘any’.
-- local_id (
strorNone) – Local ID of the IPsec Site. Defaults to the local IP.
- - enable_pfs (
boolorNone) – Enable/disable Perfect Forward Secrecy. Default is true.
- - authentication_mode (
strorNone) – Authentication mode for the IPsec Site. Valid values are psk and -x.509, with psk as default.
- - peer_subnets (
SubnetsorNone) – Peer subnets for which IPsec VPN is configured.
- - dh_group (
strorNone) – Diffie-Hellman algorithm group. Defaults to DH14 for FIPS enabled +peerIp is ‘any’.
+ local_id (
strorNone) – Local ID of the IPsec Site. Defaults to the local IP.
+enable_pfs (
boolorNone) – Enable/disable Perfect Forward Secrecy. Default is true.
+authentication_mode (
strorNone) – Authentication mode for the IPsec Site. Valid values are psk and +x.509, with psk as default.
+peer_subnets (
SubnetsorNone) – Peer subnets for which IPsec VPN is configured.
+dh_group (
strorNone) – Diffie-Hellman algorithm group. Defaults to DH14 for FIPS enabled NSX Edge. DH2 and DH5 are not supported when FIPS is enabled on NSX -Edge. Valid values are DH2, DH5, DH14, DH15, DH16.
-- site_id (
strorNone) – ID of the IPsec Site configuration provided by NSX Manager.
- - description (
strorNone) – Description of the IPsec Site.
- - peer_ip (
strorNone) – IP (IPv4) address or FQDN of the Peer. Can also be specified as -‘any’. Required.
- - name (
strorNone) – Name of the IPsec Site.
- - certificate (
strorNone) –
- - local_ip (
strorNone) – Local IP of the IPsec Site. Should be one of the IP addresses -configured on the uplink interfaces of the NSX Edge. Required.
- - encryption_algorithm (
strorNone) – IPsec encryption algorithm with default as aes256. Valid values are -‘aes’, ‘aes256’, ‘3des’, ‘aes-gcm’.
- - enabled (
boolorNone) – Enable/disable IPsec Site.
- - mtu (
longorNone) – MTU for the IPsec site. Defaults to the mtu of the NSX Edge vnic -specified by the localIp. Optional. format: int32
- - extension (
strorNone) –
- - peer_id (
strorNone) – Peer ID. Should be unique for all IPsec Site’s configured for an -NSX Edge.
- - local_subnets (
SubnetsorNone) – Local subnets for which IPsec VPN is configured.
+Edge. Valid values are DH2, DH5, DH14, DH15, DH16.
+ site_id (
strorNone) – ID of the IPsec Site configuration provided by NSX Manager.
+description (
strorNone) – Description of the IPsec Site.
+peer_ip (
strorNone) – IP (IPv4) address or FQDN of the Peer. Can also be specified as +‘any’. Required.
+name (
strorNone) – Name of the IPsec Site.
+certificate (
strorNone) –
+local_ip (
strorNone) – Local IP of the IPsec Site. Should be one of the IP addresses +configured on the uplink interfaces of the NSX Edge. Required.
+encryption_algorithm (
strorNone) – IPsec encryption algorithm with default as aes256. Valid values are +‘aes’, ‘aes256’, ‘3des’, ‘aes-gcm’.
+enabled (
boolorNone) – Enable/disable IPsec Site.
+mtu (
longorNone) – MTU for the IPsec site. Defaults to the mtu of the NSX Edge vnic +specified by the localIp. Optional. format: int32
+extension (
strorNone) –
+peer_id (
strorNone) – Peer ID. Should be unique for all IPsec Site’s configured for an +NSX Edge.
+local_subnets (
SubnetsorNone) – Local subnets for which IPsec VPN is configured.
+- psk (
com.vmware.vmc.model_client.IpsecSite(psk=None, local_id=None, enable_pfs=None, authentication_mode=None, peer_subnets=None, dh_group=None, site_id=None, description=None, peer_ip=None, name=None, certificate=None, local_ip=None, encryption_algorithm=None, enabled=None, mtu=None, extension=None, peer_id=None, local_subnets=None)¶
-
-class
com.vmware.vmc.model_client.IpsecSiteIKEStatus(channel_status=None, channel_state=None, peer_ip_address=None, local_ip_address=None, peer_subnets=None, peer_id=None, last_informational_message=None, local_subnets=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- channel_status (
strorNone) –
- - channel_state (
strorNone) –
- - peer_ip_address (
strorNone) –
- - local_ip_address (
strorNone) –
- - peer_subnets (
listofstrorNone) –
- - peer_id (
strorNone) –
- - last_informational_message (
strorNone) –
- - local_subnets (
listofstrorNone) –
+ - Parameters +
-
+
channel_status (
strorNone) –
+channel_state (
strorNone) –
+peer_ip_address (
strorNone) –
+local_ip_address (
strorNone) –
+peer_subnets (
listofstrorNone) –
+peer_id (
strorNone) –
+last_informational_message (
strorNone) –
+local_subnets (
listofstrorNone) –
-
+
+- channel_status (
com.vmware.vmc.model_client.IpsecSiteIKEStatus(channel_status=None, channel_state=None, peer_ip_address=None, local_ip_address=None, peer_subnets=None, peer_id=None, last_informational_message=None, local_subnets=None)¶
-
-class
com.vmware.vmc.model_client.IpsecSiteStats(rx_bytes_on_site=None, tunnel_stats=None, ike_status=None, site_status=None, tx_bytes_from_site=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- rx_bytes_on_site (
longorNone) –
- - tunnel_stats (
listofIpsecTunnelStatsorNone) –
- - ike_status (
IpsecSiteIKEStatusorNone) –
- - site_status (
strorNone) –
- - tx_bytes_from_site (
longorNone) –
+ - Parameters +
-
+
rx_bytes_on_site (
longorNone) –
+tunnel_stats (
listofIpsecTunnelStatsorNone) –
+ike_status (
IpsecSiteIKEStatusorNone) –
+site_status (
strorNone) –
+tx_bytes_from_site (
longorNone) –
-
+
+- rx_bytes_on_site (
com.vmware.vmc.model_client.IpsecSiteStats(rx_bytes_on_site=None, tunnel_stats=None, ike_status=None, site_status=None, tx_bytes_from_site=None)¶
-
-class
com.vmware.vmc.model_client.IpsecSites(sites=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructList of IPsec sites for NSX Edge.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: sites ( -listofIpsecSiteorNone) –-
+
- Parameters +
sites (
+listofIpsecSiteorNone) –
+
com.vmware.vmc.model_client.IpsecSites(sites=None)¶
-
-class
com.vmware.vmc.model_client.IpsecStatusAndStats(time_stamp=None, server_status=None, site_statistics=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- time_stamp (
longorNone) –
- - server_status (
strorNone) –
- - site_statistics (
listofIpsecSiteStatsorNone) –
+ - Parameters +
-
+
time_stamp (
longorNone) –
+server_status (
strorNone) –
+site_statistics (
listofIpsecSiteStatsorNone) –
-
+
+- time_stamp (
com.vmware.vmc.model_client.IpsecStatusAndStats(time_stamp=None, server_status=None, site_statistics=None)¶
-
-class
com.vmware.vmc.model_client.IpsecTunnelStats(tunnel_status=None, peer_spi=None, rx_bytes_on_local_subnet=None, established_date=None, peer_subnet=None, authentication_algorithm=None, tunnel_state=None, tx_bytes_from_local_subnet=None, last_informational_message=None, local_spi=None, encryption_algorithm=None, local_subnet=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- tunnel_status (
strorNone) –
- - peer_spi (
strorNone) –
- - rx_bytes_on_local_subnet (
longorNone) –
- - established_date (
strorNone) –
- - peer_subnet (
strorNone) –
- - authentication_algorithm (
strorNone) –
- - tunnel_state (
strorNone) –
- - tx_bytes_from_local_subnet (
longorNone) –
- - last_informational_message (
strorNone) –
- - local_spi (
strorNone) –
- - encryption_algorithm (
strorNone) –
- - local_subnet (
strorNone) –
+ - Parameters +
-
+
tunnel_status (
strorNone) –
+peer_spi (
strorNone) –
+rx_bytes_on_local_subnet (
longorNone) –
+established_date (
strorNone) –
+peer_subnet (
strorNone) –
+authentication_algorithm (
strorNone) –
+tunnel_state (
strorNone) –
+tx_bytes_from_local_subnet (
longorNone) –
+last_informational_message (
strorNone) –
+local_spi (
strorNone) –
+encryption_algorithm (
strorNone) –
+local_subnet (
strorNone) –
-
+
+- tunnel_status (
com.vmware.vmc.model_client.IpsecTunnelStats(tunnel_status=None, peer_spi=None, rx_bytes_on_local_subnet=None, established_date=None, peer_subnet=None, authentication_algorithm=None, tunnel_state=None, tx_bytes_from_local_subnet=None, last_informational_message=None, local_spi=None, encryption_algorithm=None, local_subnet=None)¶
-
-class
com.vmware.vmc.model_client.KeyValueAttributes(value=None, key=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructKey value pair describing the feature configuration limit.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- value (
strorNone) – Value corresponding to the key of the configuration limit -parameter.
- - key (
strorNone) – Key name of the configuration limit parameter.
+ - Parameters +
-
+
value (
strorNone) – Value corresponding to the key of the configuration limit +parameter.
+key (
strorNone) – Key name of the configuration limit parameter.
-
+
+- value (
com.vmware.vmc.model_client.KeyValueAttributes(value=None, key=None)¶
-
-class
com.vmware.vmc.model_client.KmsVpcEndpoint(vpc_endpoint_id=None, network_interface_ids=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- vpc_endpoint_id (
strorNone) – The identifier of the VPC endpoint created to AWS Key Management -Service
- - network_interface_ids (
listofstrorNone) –
+ - Parameters +
-
+
vpc_endpoint_id (
strorNone) – The identifier of the VPC endpoint created to AWS Key Management +Service
+network_interface_ids (
listofstrorNone) –
-
+
+- vpc_endpoint_id (
com.vmware.vmc.model_client.KmsVpcEndpoint(vpc_endpoint_id=None, network_interface_ids=None)¶
-
-class
com.vmware.vmc.model_client.L2Extension(tunnel_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructLayer 2 extension.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: tunnel_id ( -long) – Identifier for layer 2 extension tunnel. Valid range: 1-4093. -format: int32-
+
- Parameters +
tunnel_id (
+long) – Identifier for layer 2 extension tunnel. Valid range: 1-4093. +format: int32
+
com.vmware.vmc.model_client.L2Extension(tunnel_id=None)¶
-
-class
com.vmware.vmc.model_client.L2Vpn(enabled=None, sites=None, listener_ip=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- enabled (
boolorNone) – Enable (true) or disable (false) L2 VPN.
- - sites (
listofSite) – Array of L2 vpn site config.
- - listener_ip (
strorNone) – Public uplink ip address. IP of external interface on which L2VPN -service listens to.
+ - Parameters +
-
+
enabled (
boolorNone) – Enable (true) or disable (false) L2 VPN.
+sites (
listofSite) – Array of L2 vpn site config.
+listener_ip (
strorNone) – Public uplink ip address. IP of external interface on which L2VPN +service listens to.
-
+
+- enabled (
com.vmware.vmc.model_client.L2Vpn(enabled=None, sites=None, listener_ip=None)¶
-
-class
com.vmware.vmc.model_client.L2vpnStats(tunnel_status=None, established_date=None, name=None, dropped_rx_packets=None, encryption_algorithm=None, failure_message=None, tx_bytes_from_local_subnet=None, rx_bytes_on_local_subnet=None, dropped_tx_packets=None, last_updated_time=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructL2 VPN status and statistics of a single L2 VPN site.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- tunnel_status (
strorNone) – Status of the tunnel (UP/DOWN).
- - established_date (
longorNone) – Tunnel established date. format: int64
- - name (
strorNone) – User defined name of the site.
- - dropped_rx_packets (
longorNone) – Number of received packets dropped.
- - encryption_algorithm (
strorNone) – Cipher used in encryption.
- - failure_message (
strorNone) – Reason for the tunnel down.
- - tx_bytes_from_local_subnet (
longorNone) – Number of bytes transferred from local subnet.
- - rx_bytes_on_local_subnet (
longorNone) – Number of bytes received on the local subnet.
- - dropped_tx_packets (
longorNone) – Number of transferred packets dropped.
- - last_updated_time (
longorNone) – Time stamp of the statistics collection. format: int64
+ - Parameters +
-
+
tunnel_status (
strorNone) – Status of the tunnel (UP/DOWN).
+established_date (
longorNone) – Tunnel established date. format: int64
+name (
strorNone) – User defined name of the site.
+dropped_rx_packets (
longorNone) – Number of received packets dropped.
+encryption_algorithm (
strorNone) – Cipher used in encryption.
+failure_message (
strorNone) – Reason for the tunnel down.
+tx_bytes_from_local_subnet (
longorNone) – Number of bytes transferred from local subnet.
+rx_bytes_on_local_subnet (
longorNone) – Number of bytes received on the local subnet.
+dropped_tx_packets (
longorNone) – Number of transferred packets dropped.
+last_updated_time (
longorNone) – Time stamp of the statistics collection. format: int64
-
+
+- tunnel_status (
com.vmware.vmc.model_client.L2vpnStats(tunnel_status=None, established_date=None, name=None, dropped_rx_packets=None, encryption_algorithm=None, failure_message=None, tx_bytes_from_local_subnet=None, rx_bytes_on_local_subnet=None, dropped_tx_packets=None, last_updated_time=None)¶
-
-class
com.vmware.vmc.model_client.L2vpnStatusAndStats(time_stamp=None, server_status=None, site_stats=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructL2 VPN status and statistics.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- time_stamp (
longorNone) – Time stamp of statistics collection. format: int64
- - server_status (
strorNone) –
- - site_stats (
listofL2vpnStatsorNone) – List of statistics for each Site.
+ - Parameters +
-
+
time_stamp (
longorNone) – Time stamp of statistics collection. format: int64
+server_status (
strorNone) –
+site_stats (
listofL2vpnStatsorNone) – List of statistics for each Site.
-
+
+- time_stamp (
com.vmware.vmc.model_client.L2vpnStatusAndStats(time_stamp=None, server_status=None, site_stats=None)¶
-
-class
com.vmware.vmc.model_client.LicenceAclPermissions(data_permission=None, is_licensed=None, access_permission=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructLicence and access control information for the feature.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- data_permission (
DataPermissionsorNone) – Data access control information for the feature.
- - is_licensed (
boolorNone) – Value is true if feature is licenced.
- - access_permission (
InteractionPermissionsorNone) – Access control information for the feature.
+ - Parameters +
-
+
data_permission (
DataPermissionsorNone) – Data access control information for the feature.
+is_licensed (
boolorNone) – Value is true if feature is licenced.
+access_permission (
InteractionPermissionsorNone) – Access control information for the feature.
-
+
+- data_permission (
com.vmware.vmc.model_client.LicenceAclPermissions(data_permission=None, is_licensed=None, access_permission=None)¶
-
-class
com.vmware.vmc.model_client.LoadBalancerDashboardStats(lb_bps_in=None, lb_http_reqs=None, lb_bps_out=None, lb_sessions=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDashboard Statistics data for Load Balancer.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- lb_bps_in (
listofDashboardStatorNone) – Number of bytes in.
- - lb_http_reqs (
listofDashboardStatorNone) – Number of HTTP requests received by Load Balancer.
- - lb_bps_out (
listofDashboardStatorNone) – Number of bytes out.
- - lb_sessions (
listofDashboardStatorNone) – Number of Load Balancer sessions.
+ - Parameters +
-
+
lb_bps_in (
listofDashboardStatorNone) – Number of bytes in.
+lb_http_reqs (
listofDashboardStatorNone) – Number of HTTP requests received by Load Balancer.
+lb_bps_out (
listofDashboardStatorNone) – Number of bytes out.
+lb_sessions (
listofDashboardStatorNone) – Number of Load Balancer sessions.
-
+
+- lb_bps_in (
com.vmware.vmc.model_client.LoadBalancerDashboardStats(lb_bps_in=None, lb_http_reqs=None, lb_bps_out=None, lb_sessions=None)¶
-
-class
com.vmware.vmc.model_client.Logging(log_level=None, enable=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructlogging.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- log_level (
strorNone) – Log level. Valid values: emergency, alert, critical, error, -warning, notice, info, debug.
- - enable (
boolorNone) – Logging enabled.
+ - Parameters +
-
+
log_level (
strorNone) – Log level. Valid values: emergency, alert, critical, error, +warning, notice, info, debug.
+enable (
boolorNone) – Logging enabled.
-
+
+- log_level (
com.vmware.vmc.model_client.Logging(log_level=None, enable=None)¶
-
-class
com.vmware.vmc.model_client.LogicalNetwork(subnet_cidr=None, name=None, gateway_ip=None, dhcp_enabled=None, dhcp_ip_range=None, tunnel_id=None, id=None, network_type=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- subnet_cidr (
strorNone) – the subnet cidr
- - name (
strorNone) – name of the network
- - gateway_ip (
strorNone) – gateway ip of the logical network
- - dhcp_enabled (
strorNone) – if ‘true’ - enabled; if ‘false’ - disabled
- - dhcp_ip_range (
strorNone) – ip range within the subnet mask, range delimiter is ‘-‘ (example -10.118.10.130-10.118.10.140)
- - tunnel_id (
longorNone) – tunnel id of extended network format: int32
- - id (
strorNone) –
- - network_type (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
subnet_cidr (
strorNone) – the subnet cidr
+name (
strorNone) – name of the network
+gateway_ip (
strorNone) – gateway ip of the logical network
+dhcp_enabled (
strorNone) – if ‘true’ - enabled; if ‘false’ - disabled
+dhcp_ip_range (
strorNone) – ip range within the subnet mask, range delimiter is ‘-‘ (example +10.118.10.130-10.118.10.140)
+tunnel_id (
longorNone) – tunnel id of extended network format: int32
+id (
strorNone) –
+network_type (
strorNone) –Possible values are:
-
+
+- subnet_cidr (
com.vmware.vmc.model_client.LogicalNetwork(subnet_cidr=None, name=None, gateway_ip=None, dhcp_enabled=None, dhcp_ip_range=None, tunnel_id=None, id=None, network_type=None)¶
-
-class
com.vmware.vmc.model_client.LogicalRouterScope(type=None, id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- type (
strorNone) –
- - id (
strorNone) –
+ - Parameters +
-
+
type (
strorNone) –
+id (
strorNone) –
-
+
+- type (
com.vmware.vmc.model_client.LogicalRouterScope(type=None, id=None)¶
-
-class
com.vmware.vmc.model_client.LogicalRouterScopes(logical_router_scope=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: logical_router_scope ( -listofLogicalRouterScopeorNone) –-
+
- Parameters +
logical_router_scope (
+listofLogicalRouterScopeorNone) –
+
com.vmware.vmc.model_client.LogicalRouterScopes(logical_router_scope=None)¶
-
-class
com.vmware.vmc.model_client.MacAddress(edge_vm_ha_index=None, value=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- edge_vm_ha_index (
longorNone) –
- - value (
strorNone) –
+ - Parameters +
-
+
edge_vm_ha_index (
longorNone) –
+value (
strorNone) –
-
+
+- edge_vm_ha_index (
com.vmware.vmc.model_client.MacAddress(edge_vm_ha_index=None, value=None)¶
-
-class
com.vmware.vmc.model_client.MaintenanceWindow(day_of_week=None, hour_of_day=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- day_of_week (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
day_of_week (
strorNone) –Possible values are:
-
-- hour_of_day (
longorNone) –
+
+ hour_of_day (
longorNone) –
+- day_of_week (
com.vmware.vmc.model_client.MaintenanceWindow(day_of_week=None, hour_of_day=None)¶
-
-class
com.vmware.vmc.model_client.MaintenanceWindowEntry(in_maintenance_window=None, reservation_schedule=None, reservation_id=None, in_maintenance_mode=None, sddc_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- in_maintenance_window (
boolorNone) – true if the SDDC is in the defined Mainentance Window
- - reservation_schedule (
ReservationScheduleorNone) –
- - reservation_id (
strorNone) – ID for reservation format: uuid
- - in_maintenance_mode (
boolorNone) – true if the SDDC is currently undergoing maintenance
- - sddc_id (
strorNone) – SDDC ID for this reservation format: uuid
+ - Parameters +
-
+
in_maintenance_window (
boolorNone) – true if the SDDC is in the defined Mainentance Window
+reservation_schedule (
ReservationScheduleorNone) –
+reservation_id (
strorNone) – ID for reservation format: uuid
+in_maintenance_mode (
boolorNone) – true if the SDDC is currently undergoing maintenance
+sddc_id (
strorNone) – SDDC ID for this reservation format: uuid
-
+
+- in_maintenance_window (
com.vmware.vmc.model_client.MaintenanceWindowEntry(in_maintenance_window=None, reservation_schedule=None, reservation_id=None, in_maintenance_mode=None, sddc_id=None)¶
-
-class
com.vmware.vmc.model_client.MaintenanceWindowGet(day_of_week=None, hour_of_day=None, duration_min=None, version=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- day_of_week (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
day_of_week (
strorNone) –Possible values are:
-
-
MaintenanceWindowGet.DAY_OF_WEEK_SUNDAY
-MaintenanceWindowGet.DAY_OF_WEEK_MONDAY
-MaintenanceWindowGet.DAY_OF_WEEK_TUESDAY
-MaintenanceWindowGet.DAY_OF_WEEK_WEDNESDAY
-MaintenanceWindowGet.DAY_OF_WEEK_THURSDAY
-MaintenanceWindowGet.DAY_OF_WEEK_FRIDAY
-MaintenanceWindowGet.DAY_OF_WEEK_SATURDAY
+- +
- +
- +
- +
- +
- +
-- hour_of_day (
longorNone) –
- - duration_min (
longorNone) –
- - version (
longorNone) –
+
+ hour_of_day (
longorNone) –
+duration_min (
longorNone) –
+version (
longorNone) –
+- day_of_week (
com.vmware.vmc.model_client.MaintenanceWindowGet(day_of_week=None, hour_of_day=None, duration_min=None, version=None)¶
-
-class
com.vmware.vmc.model_client.ManagementGatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, subnet_cidr=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- public_ip (
SddcPublicIporNone) –
- - primary_dns (
strorNone) –
- - secondary_dns (
strorNone) –
- - firewall_rules (
listofFirewallRuleorNone) –
- - vpns (
listofVpnorNone) –
- - subnet_cidr (
strorNone) – mgw network subnet cidr
+ - Parameters +
-
+
public_ip (
SddcPublicIporNone) –
+primary_dns (
strorNone) –
+secondary_dns (
strorNone) –
+firewall_rules (
listofFirewallRuleorNone) –
+vpns (
listofVpnorNone) –
+subnet_cidr (
strorNone) – mgw network subnet cidr
-
+
+- public_ip (
com.vmware.vmc.model_client.ManagementGatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, subnet_cidr=None)¶
-
-class
com.vmware.vmc.model_client.MapZonesRequest(connected_account_id=None, org_id=None, petronas_regions_to_map=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- connected_account_id (
strorNone) – The connected account ID to remap. This is a standard UUID.
- - org_id (
strorNone) – The org ID to remap in. This is a standard UUID.
- - petronas_regions_to_map (
listofstrorNone) – A list of Petronas regions to map.
+ - Parameters +
-
+
connected_account_id (
strorNone) – The connected account ID to remap. This is a standard UUID.
+org_id (
strorNone) – The org ID to remap in. This is a standard UUID.
+petronas_regions_to_map (
listofstrorNone) – A list of Petronas regions to map.
-
+
+- connected_account_id (
com.vmware.vmc.model_client.MapZonesRequest(connected_account_id=None, org_id=None, petronas_regions_to_map=None)¶
-
-class
com.vmware.vmc.model_client.MetaDashboardStats(vnics=None, end_time=None, start_time=None, interval=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructStart time, end time and interval details.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- vnics (
listofVnicorNone) – Statistics data is collected for these vNICs.
- - end_time (
longorNone) – End time in seconds. format: int64
- - start_time (
longorNone) – Start time in seconds. format: int64
- - interval (
longorNone) – Time interval in seconds. format: int32
+ - Parameters +
-
+
vnics (
listofVnicorNone) – Statistics data is collected for these vNICs.
+end_time (
longorNone) – End time in seconds. format: int64
+start_time (
longorNone) – Start time in seconds. format: int64
+interval (
longorNone) – Time interval in seconds. format: int32
-
+
+- vnics (
com.vmware.vmc.model_client.MetaDashboardStats(vnics=None, end_time=None, start_time=None, interval=None)¶
-
-class
com.vmware.vmc.model_client.Metadata(timestamp=None, cycle_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructmetadata of the sddc manifest
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- timestamp (
strorNone) – the timestamp for the bundle
- - cycle_id (
strorNone) – the cycle id
+ - Parameters +
-
+
timestamp (
strorNone) – the timestamp for the bundle
+cycle_id (
strorNone) – the cycle id
-
+
+- timestamp (
com.vmware.vmc.model_client.Metadata(timestamp=None, cycle_id=None)¶
-
-class
com.vmware.vmc.model_client.Nat(rules=None, feature_type=None, version=None, enabled=None, template=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNAT configuration
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- rules (
NatRulesorNone) – Ordered list of NAT rules.
- - feature_type (
strorNone) –
- - version (
longorNone) – Version number tracking each configuration change. To avoid +-
+
- Parameters +
-
+
rules (
NatRulesorNone) – Ordered list of NAT rules.
+feature_type (
strorNone) –
+version (
longorNone) – Version number tracking each configuration change. To avoid problems with overwriting changes, always retrieve and modify the latest configuration to include the current version number in your request. If you provide a version number which is not current, the request is rejected. If you omit the version number, the request is accepted but may overwrite any current changes if your change is -not in sync with the latest change. format: int64
-- enabled (
boolorNone) – Value is true if feature is enabled. Default value is true. -Optional.
- - template (
strorNone) –
+not in sync with the latest change. format: int64
+ enabled (
boolorNone) – Value is true if feature is enabled. Default value is true. +Optional.
+template (
strorNone) –
+- rules (
com.vmware.vmc.model_client.Nat(rules=None, feature_type=None, version=None, enabled=None, template=None)¶
-
-class
com.vmware.vmc.model_client.NatRule(rule_type=None, protocol=None, name=None, internal_ports=None, public_ports=None, public_ip=None, internal_ip=None, action=None, id=None, revision=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- rule_type (
strorNone) –
- - protocol (
strorNone) –
- - name (
strorNone) –
- - internal_ports (
strorNone) –
- - public_ports (
strorNone) –
- - public_ip (
strorNone) –
- - internal_ip (
strorNone) –
- - action (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
rule_type (
strorNone) –
+protocol (
strorNone) –
+name (
strorNone) –
+internal_ports (
strorNone) –
+public_ports (
strorNone) –
+public_ip (
strorNone) –
+internal_ip (
strorNone) –
+action (
strorNone) –Possible values are:
-
-- id (
strorNone) –
- - revision (
longorNone) – current revision of the list of nat rules, used to protect against +
+ id (
strorNone) –
+revision (
longorNone) – current revision of the list of nat rules, used to protect against concurrent modification (first writer wins) format: int32 This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.
+it is present in a request to server it will be ignored.
+- rule_type (
com.vmware.vmc.model_client.NatRule(rule_type=None, protocol=None, name=None, internal_ports=None, public_ports=None, public_ip=None, internal_ip=None, action=None, id=None, revision=None)¶
-
-class
com.vmware.vmc.model_client.NatRules(nat_rules_dtos=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructOrdered list of NAT rules.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: nat_rules_dtos ( -listofNsxnatruleorNone) – Ordered list of NAT rules.-
+
- Parameters +
nat_rules_dtos (
+listofNsxnatruleorNone) – Ordered list of NAT rules.
+
com.vmware.vmc.model_client.NatRules(nat_rules_dtos=None)¶
-
-class
com.vmware.vmc.model_client.NetworkTemplate(management_gateway_templates=None, compute_gateway_templates=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- management_gateway_templates (
listofManagementGatewayTemplateorNone) –
- - compute_gateway_templates (
listofComputeGatewayTemplateorNone) –
+ - Parameters +
-
+
management_gateway_templates (
listofManagementGatewayTemplateorNone) –
+compute_gateway_templates (
listofComputeGatewayTemplateorNone) –
-
+
+- management_gateway_templates (
com.vmware.vmc.model_client.NetworkTemplate(management_gateway_templates=None, compute_gateway_templates=None)¶
-
-class
com.vmware.vmc.model_client.NewCredentials(username=None, password=None, name=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- username (
str) – Username of the credentials
- - password (
str) – Password associated with the credentials
- - name (
str) – Name of the credentials
+ - Parameters +
-
+
username (
str) – Username of the credentials
+password (
str) – Password associated with the credentials
+name (
str) – Name of the credentials
-
+
+- username (
com.vmware.vmc.model_client.NewCredentials(username=None, password=None, name=None)¶
-
-class
com.vmware.vmc.model_client.Nsxfirewallrule(rule_type=None, description=None, rule_id=None, match_translated=None, invalid_application=None, direction=None, statistics=None, name=None, invalid_source=None, logging_enabled=None, destination=None, enabled=None, application=None, source=None, action=None, invalid_destination=None, rule_tag=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructFirewall Rule
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- rule_type (
strorNone) – Identifies the type of the rule. internal_high or user.
- - description (
strorNone) – Description for the rule
- - rule_id (
longorNone) – Identifier for the rule. format: int64
- - match_translated (
boolorNone) – Defines the order of NAT and Firewall pipeline. When false, -firewall happens before NAT. Default : false
- - invalid_application (
boolorNone) –
- - direction (
strorNone) – Direction. Possible values in or out. Default is ‘any’.
- - statistics (
FirewallRuleStatsorNone) – Statistics for the rule
- - name (
strorNone) – Name for the rule.
- - invalid_source (
boolorNone) –
- - logging_enabled (
boolorNone) – Enable logging for the rule.
- - destination (
AddressFWSourceDestinationorNone) – List of destinations. Default is any.
- - enabled (
boolorNone) – Enable rule.
- - application (
ApplicationorNone) – List of applications. Default is any.
- - source (
AddressFWSourceDestinationorNone) – List of sources. Default is any.
- - action (
strorNone) – Action. Values : accept, deny
- - invalid_destination (
boolorNone) –
- - rule_tag (
longorNone) – Rule tag. Used to specify user-defined ruleId. If not specified NSX -Manager will generate ruleId. format: int64
+ - Parameters +
-
+
rule_type (
strorNone) – Identifies the type of the rule. internal_high or user.
+description (
strorNone) – Description for the rule
+rule_id (
longorNone) – Identifier for the rule. format: int64
+match_translated (
boolorNone) – Defines the order of NAT and Firewall pipeline. When false, +firewall happens before NAT. Default : false
+invalid_application (
boolorNone) –
+direction (
strorNone) – Direction. Possible values in or out. Default is ‘any’.
+statistics (
FirewallRuleStatsorNone) – Statistics for the rule
+name (
strorNone) – Name for the rule.
+invalid_source (
boolorNone) –
+logging_enabled (
boolorNone) – Enable logging for the rule.
+destination (
AddressFWSourceDestinationorNone) – List of destinations. Default is any.
+enabled (
boolorNone) – Enable rule.
+application (
ApplicationorNone) – List of applications. Default is any.
+source (
AddressFWSourceDestinationorNone) – List of sources. Default is any.
+action (
strorNone) – Action. Values : accept, deny
+invalid_destination (
boolorNone) –
+rule_tag (
longorNone) – Rule tag. Used to specify user-defined ruleId. If not specified NSX +Manager will generate ruleId. format: int64
-
+
+- rule_type (
com.vmware.vmc.model_client.Nsxfirewallrule(rule_type=None, description=None, rule_id=None, match_translated=None, invalid_application=None, direction=None, statistics=None, name=None, invalid_source=None, logging_enabled=None, destination=None, enabled=None, application=None, source=None, action=None, invalid_destination=None, rule_tag=None)¶
-
-class
com.vmware.vmc.model_client.Nsxfirewallservice(source_port=None, protocol=None, port=None, icmp_type=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructApplication (service) for firewall rule.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- source_port (
listofstrorNone) – List of source ports.
- - protocol (
strorNone) – Protocol.
- - port (
listofstrorNone) – List of destination ports.
- - icmp_type (
strorNone) – IcmpType. Only supported when protocol is icmp. Default is ‘any’.
+ - Parameters +
-
+
source_port (
listofstrorNone) – List of source ports.
+protocol (
strorNone) – Protocol.
+port (
listofstrorNone) – List of destination ports.
+icmp_type (
strorNone) – IcmpType. Only supported when protocol is icmp. Default is ‘any’.
-
+
+- source_port (
com.vmware.vmc.model_client.Nsxfirewallservice(source_port=None, protocol=None, port=None, icmp_type=None)¶
-
-class
com.vmware.vmc.model_client.Nsxl2vpn(listener_ips=None, enabled=None, sites=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructL2 VPN server configuration.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- listener_ips (
listofstr) – Listener IP addresses.
- - enabled (
boolorNone) – Enabled state of L2 VPN service.
- - sites (
Sites) – List of L2 VPN sites.
+ - Parameters +
-
+
listener_ips (
listofstr) – Listener IP addresses.
+enabled (
boolorNone) – Enabled state of L2 VPN service.
+sites (
Sites) – List of L2 VPN sites.
-
+
+- listener_ips (
com.vmware.vmc.model_client.Nsxl2vpn(listener_ips=None, enabled=None, sites=None)¶
-
-class
com.vmware.vmc.model_client.Nsxnatrule(vnic=None, rule_type=None, protocol=None, description=None, rule_id=None, snat_match_destination_port=None, original_address=None, dnat_match_source_address=None, dnat_match_source_port=None, snat_match_destination_address=None, original_port=None, logging_enabled=None, translated_address=None, enabled=None, icmp_type=None, translated_port=None, action=None, rule_tag=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNAT rule
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- vnic (
strorNone) – Interface on which the NAT rule is applied.
- - rule_type (
strorNone) – Identifies the type of the rule. internal_high or user.
- - protocol (
strorNone) – Protocol. Default is ‘any’
- - description (
strorNone) – Description for the rule.
- - rule_id (
longorNone) – Identifier for the rule. format: int64
- - snat_match_destination_port (
strorNone) – Apply SNAT rule only if traffic has this destination port. Default -is ‘any’.
- - original_address (
strorNone) – Original address or address range. This is the original source +-
+
- Parameters +
-
+
vnic (
strorNone) – Interface on which the NAT rule is applied.
+rule_type (
strorNone) – Identifies the type of the rule. internal_high or user.
+protocol (
strorNone) – Protocol. Default is ‘any’
+description (
strorNone) – Description for the rule.
+rule_id (
longorNone) – Identifier for the rule. format: int64
+snat_match_destination_port (
strorNone) – Apply SNAT rule only if traffic has this destination port. Default +is ‘any’.
+original_address (
strorNone) – Original address or address range. This is the original source address for SNAT rules and the original destination address for -DNAT rules.
-- dnat_match_source_address (
strorNone) – Apply DNAT rule only if traffic has this source address. Default is -‘any’.
- - dnat_match_source_port (
strorNone) – Apply DNAT rule only if traffic has this source port. Default is -‘any’.
- - snat_match_destination_address (
strorNone) – Apply SNAT rule only if traffic has this destination address. -Default is ‘any’.
- - original_port (
strorNone) – Original port. This is the original source port for SNAT rules, and -the original destination port for DNAT rules.
- - logging_enabled (
boolorNone) – Enable logging for the rule.
- - translated_address (
strorNone) – Translated address or address range.
- - enabled (
boolorNone) – Enable rule.
- - icmp_type (
strorNone) – ICMP type. Only supported when protocol is icmp. Default is ‘any’.
- - translated_port (
strorNone) – Translated port. Supported in DNAT rules only.
- - action (
strorNone) – Action for the rule. SNAT or DNAT.
- - rule_tag (
longorNone) – Rule tag. Used to specify user-defined ruleId. If not specified NSX -Manager will generate ruleId. format: int64
+DNAT rules.
+ dnat_match_source_address (
strorNone) – Apply DNAT rule only if traffic has this source address. Default is +‘any’.
+dnat_match_source_port (
strorNone) – Apply DNAT rule only if traffic has this source port. Default is +‘any’.
+snat_match_destination_address (
strorNone) – Apply SNAT rule only if traffic has this destination address. +Default is ‘any’.
+original_port (
strorNone) – Original port. This is the original source port for SNAT rules, and +the original destination port for DNAT rules.
+logging_enabled (
boolorNone) – Enable logging for the rule.
+translated_address (
strorNone) – Translated address or address range.
+enabled (
boolorNone) – Enable rule.
+icmp_type (
strorNone) – ICMP type. Only supported when protocol is icmp. Default is ‘any’.
+translated_port (
strorNone) – Translated port. Supported in DNAT rules only.
+action (
strorNone) – Action for the rule. SNAT or DNAT.
+rule_tag (
longorNone) – Rule tag. Used to specify user-defined ruleId. If not specified NSX +Manager will generate ruleId. format: int64
+- vnic (
com.vmware.vmc.model_client.Nsxnatrule(vnic=None, rule_type=None, protocol=None, description=None, rule_id=None, snat_match_destination_port=None, original_address=None, dnat_match_source_address=None, dnat_match_source_port=None, snat_match_destination_address=None, original_port=None, logging_enabled=None, translated_address=None, enabled=None, icmp_type=None, translated_port=None, action=None, rule_tag=None)¶
-
-class
com.vmware.vmc.model_client.Nsxsite(secure_traffic=None, site_id=None, name=None, password=None, user_id=None, description=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructL2 VPN site.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- secure_traffic (
boolorNone) – Secure L2VPN traffic.
- - site_id (
strorNone) – Identifier for L2 VPN site.
- - name (
strorNone) – Name of L2 VPN site. Length: 1-255 characters.
- - password (
strorNone) – Password for L2 VPN user. Passwords must contain the following: +-
+
- Parameters +
-
+
secure_traffic (
boolorNone) – Secure L2VPN traffic.
+site_id (
strorNone) – Identifier for L2 VPN site.
+name (
strorNone) – Name of L2 VPN site. Length: 1-255 characters.
+password (
strorNone) – Password for L2 VPN user. Passwords must contain the following: 12-63 characters, a mix of upper case letters, lower case letters, numbers, and at least one special character. Password must not contain the username as a substring. Do not repeat a character 3 or -more times.
-- user_id (
strorNone) – L2 VPN user ID. Valid user names: 1-63 characters, letters and -numbers only. No white space or special characters.
- - description (
strorNone) – Description of L2 VPN site.
+more times.
+ user_id (
strorNone) – L2 VPN user ID. Valid user names: 1-63 characters, letters and +numbers only. No white space or special characters.
+description (
strorNone) – Description of L2 VPN site.
+- secure_traffic (
com.vmware.vmc.model_client.Nsxsite(secure_traffic=None, site_id=None, name=None, password=None, user_id=None, description=None)¶
-
-class
com.vmware.vmc.model_client.NsxtAddons(enable_nsx_advanced_addon=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDetails the state of different NSX add-ons.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: enable_nsx_advanced_addon ( -boolorNone) – Indicates whether NSX Advanced addon is enabled or disabled.-
+
- Parameters +
enable_nsx_advanced_addon (
+boolorNone) – Indicates whether NSX Advanced addon is enabled or disabled.
+
com.vmware.vmc.model_client.NsxtAddons(enable_nsx_advanced_addon=None)¶
-
-class
com.vmware.vmc.model_client.ObjectType(name=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: name ( -strorNone) –-
+
- Parameters +
name (
+strorNone) –
+
com.vmware.vmc.model_client.ObjectType(name=None)¶
-
-class
com.vmware.vmc.model_client.OfferInstancesHolder(on_demand=None, offers=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructHolder for the offer instances.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- on_demand (
OnDemandOfferInstance) –
- - offers (
listofTermOfferInstance) –
+ - Parameters +
-
+
on_demand (
OnDemandOfferInstance) –
+offers (
listofTermOfferInstance) –
-
+
+- on_demand (
com.vmware.vmc.model_client.OfferInstancesHolder(on_demand=None, offers=None)¶
-
-class
com.vmware.vmc.model_client.OfferType(string)¶
+class Bases:
vmware.vapi.bindings.enum.Enum--Note
-This class represents an enumerated type in the interface language +
Note
+This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the @@ -4340,874 +3871,797 @@ enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.
-
+- - - Parameters: string ( -str) – String value for theOfferTypeinstance.-
+
- Parameters +
string (
+str) – String value for theOfferTypeinstance.
+
com.vmware.vmc.model_client.OfferType(string)¶
-
-class
com.vmware.vmc.model_client.OnDemandOfferInstance(product_type=None, name=None, currency=None, region=None, unit_price=None, monthly_cost=None, version=None, description=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructHolder for the on-demand offer instance.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- product_type (
str) –
- - name (
str) –
- - currency (
str) –
- - region (
str) –
- - unit_price (
str) –
- - monthly_cost (
str) –
- - version (
str) –
- - description (
str) –
+ - Parameters +
-
+
product_type (
str) –
+name (
str) –
+currency (
str) –
+region (
str) –
+unit_price (
str) –
+monthly_cost (
str) –
+version (
str) –
+description (
str) –
-
+
+- product_type (
com.vmware.vmc.model_client.OnDemandOfferInstance(product_type=None, name=None, currency=None, region=None, unit_price=None, monthly_cost=None, version=None, description=None)¶
-
-class
com.vmware.vmc.model_client.OrgProperties(values=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: values (( -dictofstrandstr) orNone) – A map of string properties to values.-
+
- Parameters +
values ((
+dictofstrandstr) orNone) – A map of string properties to values.
+
com.vmware.vmc.model_client.OrgProperties(values=None)¶
-
-class
com.vmware.vmc.model_client.Organization(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, org_type=None, display_name=None, name=None, project_state=None, properties=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- updated (
datetime.datetime) –
- - user_id (
str) – User id that last updated this record
- - updated_by_user_id (
str) – User id that last updated this record
- - created (
datetime.datetime) –
- - version (
long) – Version of this entity format: int32
- - updated_by_user_name (
strorNone) – User name that last updated this record
- - user_name (
str) – User name that last updated this record
- - id (
str) – Unique ID for this entity
- - org_type (
strorNone) – ORG_TYPE to be associated with the org
- - display_name (
strorNone) –
- - name (
strorNone) –
- - project_state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
updated (
datetime.datetime) –
+user_id (
str) – User id that last updated this record
+updated_by_user_id (
str) – User id that last updated this record
+created (
datetime.datetime) –
+version (
long) – Version of this entity format: int32
+updated_by_user_name (
strorNone) – User name that last updated this record
+user_name (
str) – User name that last updated this record
+id (
str) – Unique ID for this entity
+org_type (
strorNone) – ORG_TYPE to be associated with the org
+display_name (
strorNone) –
+name (
strorNone) –
+project_state (
strorNone) –Possible values are:
-
-- properties (
OrgPropertiesorNone) –
+
+ properties (
OrgPropertiesorNone) –
+- updated (
com.vmware.vmc.model_client.Organization(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, org_type=None, display_name=None, name=None, project_state=None, properties=None)¶
-
-class
com.vmware.vmc.model_client.PagedEdgeList(edge_page=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNSX Edges listed by pages.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: edge_page ( -DataPageEdgeSummaryorNone) – Page details with matched records.-
+
- Parameters +
edge_page (
+DataPageEdgeSummaryorNone) – Page details with matched records.
+
com.vmware.vmc.model_client.PagedEdgeList(edge_page=None)¶
-
-class
com.vmware.vmc.model_client.PagingInfo(sort_order_ascending=None, total_count=None, start_index=None, sort_by=None, page_size=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- sort_order_ascending (
boolorNone) –
- - total_count (
longorNone) –
- - start_index (
longorNone) –
- - sort_by (
strorNone) –
- - page_size (
longorNone) –
+ - Parameters +
-
+
sort_order_ascending (
boolorNone) –
+total_count (
longorNone) –
+start_index (
longorNone) –
+sort_by (
strorNone) –
+page_size (
longorNone) –
-
+
+- sort_order_ascending (
com.vmware.vmc.model_client.PagingInfo(sort_order_ascending=None, total_count=None, start_index=None, sort_by=None, page_size=None)¶
-
-class
com.vmware.vmc.model_client.PopAgentXeniConnection(default_subnet_route=None, eni_info=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- default_subnet_route (
strorNone) – The gateway route ip fo the subnet.
- - eni_info ((
dictofstrandEniInfo) orNone) – Information of the x-eni created.
+ - Parameters +
-
+
default_subnet_route (
strorNone) – The gateway route ip fo the subnet.
+eni_info ((
dictofstrandEniInfo) orNone) – Information of the x-eni created.
-
+
+- default_subnet_route (
com.vmware.vmc.model_client.PopAgentXeniConnection(default_subnet_route=None, eni_info=None)¶
-
-class
com.vmware.vmc.model_client.PopAmiInfo(region=None, id=None, name=None, type=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- region (
strorNone) – the region of the esx ami
- - id (
strorNone) – the ami id for the esx
- - name (
strorNone) – the name of the esx ami
- - type (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
region (
strorNone) – the region of the esx ami
+id (
strorNone) – the ami id for the esx
+name (
strorNone) – the name of the esx ami
+type (
strorNone) –Possible values are:
-
-PoP AMI type. CENTOS: a Centos AMI; POP: a PoP AMI.
+
+PoP AMI type. CENTOS: a Centos AMI; POP: a PoP AMI.
+
+- region (
com.vmware.vmc.model_client.PopAmiInfo(region=None, id=None, name=None, type=None)¶
-
-class
com.vmware.vmc.model_client.PopInfo(ami_infos=None, created_at=None, id=None, service_infos=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructPresent a SDDC PoP information.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- ami_infos (
dictofstrandPopAmiInfo) – A map of [region name of PoP / PoP-AMI]:[PopAmiInfo].
- - created_at (
datetime.datetimeorNone) – The PopInfo (or PoP AMI) created time. Using ISO 8601 date-time -pattern. format: date-time
- - id (
strorNone) – UUID of the PopInfo format: UUID
- - service_infos ((
dictofstrandPopServiceInfo) orNone) – A map of [service type]:[PopServiceInfo]
+ - Parameters +
-
+
ami_infos (
dictofstrandPopAmiInfo) – A map of [region name of PoP / PoP-AMI]:[PopAmiInfo].
+created_at (
datetime.datetimeorNone) – The PopInfo (or PoP AMI) created time. Using ISO 8601 date-time +pattern. format: date-time
+id (
strorNone) – UUID of the PopInfo format: UUID
+service_infos ((
dictofstrandPopServiceInfo) orNone) – A map of [service type]:[PopServiceInfo]
-
+
+- ami_infos (
com.vmware.vmc.model_client.PopInfo(ami_infos=None, created_at=None, id=None, service_infos=None)¶
-
-class
com.vmware.vmc.model_client.PopServiceInfo(cln=None, version=None, build=None, service=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- cln (
strorNone) – The service change set number.
- - version (
strorNone) – The service API version.
- - build (
strorNone) – The service build number.
- - service (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
cln (
strorNone) – The service change set number.
+version (
strorNone) – The service API version.
+build (
strorNone) – The service build number.
+service (
strorNone) –Possible values are:
-
-
PopServiceInfo.SERVICE_OS
-PopServiceInfo.SERVICE_AGENT
-PopServiceInfo.SERVICE_GLCM
-PopServiceInfo.SERVICE_S3_ADAPTER
-PopServiceInfo.SERVICE_JRE
-PopServiceInfo.SERVICE_DOCKER
-PopServiceInfo.SERVICE_AIDE
-PopServiceInfo.SERVICE_RTS
-PopServiceInfo.SERVICE_FM_LOG_COLLECTOR
-PopServiceInfo.SERVICE_FM_METRICS_COLLECTOR
-PopServiceInfo.SERVICE_BRE
-PopServiceInfo.SERVICE_BRF
-PopServiceInfo.SERVICE_REVERSE_PROXY
-PopServiceInfo.SERVICE_FORWARD_PROXY
-PopServiceInfo.SERVICE_DNS
-PopServiceInfo.SERVICE_NTP
-PopServiceInfo.SERVICE_LOGZ_LOG_COLLECTOR
+- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
- +
-
-An enum of PoP related services (including os platform and JRE).
+
+An enum of PoP related services (including os platform and JRE).
+
+- cln (
com.vmware.vmc.model_client.PopServiceInfo(cln=None, version=None, build=None, service=None)¶
-
-
SERVICE_FM_METRICS_COLLECTOR= 'FM_METRICS_COLLECTOR'¶
+
SERVICE_FM_METRICS_COLLECTOR = 'FM_METRICS_COLLECTOR'¶
-
-
SERVICE_LOGZ_LOG_COLLECTOR= 'LOGZ_LOG_COLLECTOR'¶
+
SERVICE_LOGZ_LOG_COLLECTOR = 'LOGZ_LOG_COLLECTOR'¶
-
-class
com.vmware.vmc.model_client.Requests(total=None, queries=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDNS request statistics.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- total (
longorNone) –
- - queries (
longorNone) –
+ - Parameters +
-
+
total (
longorNone) –
+queries (
longorNone) –
-
+
+- total (
com.vmware.vmc.model_client.Requests(total=None, queries=None)¶
-
-class
com.vmware.vmc.model_client.Reservation(duration=None, rid=None, create_time=None, start_time=None, metadata=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- duration (
longorNone) – Duration - required for reservation in maintenance window format: -int64
- - rid (
strorNone) – Reservation ID format: uuid
- - create_time (
strorNone) – Optional
- - start_time (
datetime.datetimeorNone) – Start time of a reservation format: date-time
- - metadata ((
dictofstrandstr) orNone) – Optional
+ - Parameters +
-
+
duration (
longorNone) – Duration - required for reservation in maintenance window format: +int64
+rid (
strorNone) – Reservation ID format: uuid
+create_time (
strorNone) – Optional
+start_time (
datetime.datetimeorNone) – Start time of a reservation format: date-time
+metadata ((
dictofstrandstr) orNone) – Optional
-
+
+- duration (
com.vmware.vmc.model_client.Reservation(duration=None, rid=None, create_time=None, start_time=None, metadata=None)¶
-
-class
com.vmware.vmc.model_client.ReservationInMw(rid=None, week_of=None, create_time=None, metadata=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- rid (
strorNone) – Reservation ID format: uuid
- - week_of (
strorNone) – SUNDAY of the week that maintenance is scheduled, ISO format date
- - create_time (
datetime.datetimeorNone) – Optional format: date-time
- - metadata ((
dictofstrandstr) orNone) – Optional
+ - Parameters +
-
+
rid (
strorNone) – Reservation ID format: uuid
+week_of (
strorNone) – SUNDAY of the week that maintenance is scheduled, ISO format date
+create_time (
datetime.datetimeorNone) – Optional format: date-time
+metadata ((
dictofstrandstr) orNone) – Optional
-
+
+- rid (
com.vmware.vmc.model_client.ReservationInMw(rid=None, week_of=None, create_time=None, metadata=None)¶
-
-class
com.vmware.vmc.model_client.ReservationSchedule(day_of_week=None, hour_of_day=None, duration_min=None, version=None, reservations=None, reservations_mw=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- day_of_week (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
day_of_week (
strorNone) –Possible values are:
-
-
ReservationSchedule.DAY_OF_WEEK_SUNDAY
-ReservationSchedule.DAY_OF_WEEK_MONDAY
-ReservationSchedule.DAY_OF_WEEK_TUESDAY
-ReservationSchedule.DAY_OF_WEEK_WEDNESDAY
-ReservationSchedule.DAY_OF_WEEK_THURSDAY
-ReservationSchedule.DAY_OF_WEEK_FRIDAY
-ReservationSchedule.DAY_OF_WEEK_SATURDAY
+- +
- +
- +
- +
- +
- +
-- hour_of_day (
longorNone) –
- - duration_min (
longorNone) –
- - version (
longorNone) –
- - reservations (
listofReservationorNone) –
- - reservations_mw (
listofReservationInMworNone) –
+
+ hour_of_day (
longorNone) –
+duration_min (
longorNone) –
+version (
longorNone) –
+reservations (
listofReservationorNone) –
+reservations_mw (
listofReservationInMworNone) –
+- day_of_week (
com.vmware.vmc.model_client.ReservationSchedule(day_of_week=None, hour_of_day=None, duration_min=None, version=None, reservations=None, reservations_mw=None)¶
-
-class
com.vmware.vmc.model_client.ReservationWindow(reservation_state=None, emergency=None, maintenance_properties=None, reserve_id=None, start_hour=None, sddc_id=None, manifest_id=None, duration_hours=None, start_date=None, metadata=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- reservation_state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
reservation_state (
strorNone) –Possible values are:
-
-- emergency (
boolorNone) –
- - maintenance_properties (
ReservationWindowMaintenancePropertiesorNone) –
- - reserve_id (
strorNone) –
- - start_hour (
longorNone) –
- - sddc_id (
strorNone) –
- - manifest_id (
strorNone) –
- - duration_hours (
longorNone) –
- - start_date (
strorNone) –
- - metadata ((
dictofstrandstr) orNone) – Metadata for reservation window, in key-value form
+
+ emergency (
boolorNone) –
+maintenance_properties (
ReservationWindowMaintenancePropertiesorNone) –
+reserve_id (
strorNone) –
+start_hour (
longorNone) –
+sddc_id (
strorNone) –
+manifest_id (
strorNone) –
+duration_hours (
longorNone) –
+start_date (
strorNone) –
+metadata ((
dictofstrandstr) orNone) – Metadata for reservation window, in key-value form
+- reservation_state (
com.vmware.vmc.model_client.ReservationWindow(reservation_state=None, emergency=None, maintenance_properties=None, reserve_id=None, start_hour=None, sddc_id=None, manifest_id=None, duration_hours=None, start_date=None, metadata=None)¶
-
-class
com.vmware.vmc.model_client.ReservationWindowMaintenanceProperties(status=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: status ( -strorNone) – Status of upgrade, if any-
+
- Parameters +
status (
+strorNone) – Status of upgrade, if any
+
com.vmware.vmc.model_client.ReservationWindowMaintenanceProperties(status=None)¶
-
-class
com.vmware.vmc.model_client.Result(value=None, key=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructJob result information for the configuration change carried out on NSX Edge.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- value (
strorNone) – Job Result value associated with key ID.
- - key (
strorNone) – Job Result key ID.
+ - Parameters +
-
+
value (
strorNone) – Job Result value associated with key ID.
+key (
strorNone) – Job Result key ID.
-
+
+- value (
com.vmware.vmc.model_client.Result(value=None, key=None)¶
-
-class
com.vmware.vmc.model_client.ScopeInfo(object_type_name=None, id=None, name=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- object_type_name (
strorNone) –
- - id (
strorNone) –
- - name (
strorNone) –
+ - Parameters +
-
+
object_type_name (
strorNone) –
+id (
strorNone) –
+name (
strorNone) –
-
+
+- object_type_name (
com.vmware.vmc.model_client.ScopeInfo(object_type_name=None, id=None, name=None)¶
-
-class
com.vmware.vmc.model_client.Sddc(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, name=None, sddc_state=None, expiration_date=None, org_id=None, sddc_type=None, provider=None, account_link_state=None, sddc_access_state=None, resource_config=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- updated (
datetime.datetime) –
- - user_id (
str) – User id that last updated this record
- - updated_by_user_id (
str) – User id that last updated this record
- - created (
datetime.datetime) –
- - version (
long) – Version of this entity format: int32
- - updated_by_user_name (
strorNone) – User name that last updated this record
- - user_name (
str) – User name that last updated this record
- - id (
str) – Unique ID for this entity
- - name (
strorNone) – name for SDDC
- - sddc_state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
updated (
datetime.datetime) –
+user_id (
str) – User id that last updated this record
+updated_by_user_id (
str) – User id that last updated this record
+created (
datetime.datetime) –
+version (
long) – Version of this entity format: int32
+updated_by_user_name (
strorNone) – User name that last updated this record
+user_name (
str) – User name that last updated this record
+id (
str) – Unique ID for this entity
+name (
strorNone) – name for SDDC
+sddc_state (
strorNone) –Possible values are:
-
-- expiration_date (
datetime.datetimeorNone) – Expiration date of a sddc in UTC (will be set if its applicable) -format: date-time
- - org_id (
strorNone) –
- - sddc_type (
strorNone) – Type of the sddc
- - provider (
strorNone) –Possible values are:
+
+ expiration_date (
datetime.datetimeorNone) – Expiration date of a sddc in UTC (will be set if its applicable) +format: date-time
+org_id (
strorNone) –
+sddc_type (
strorNone) – Type of the sddc
+provider (
strorNone) –Possible values are:
-
-- account_link_state (
strorNone) –Possible values are:
+
+ account_link_state (
strorNone) –Possible values are:
-
-
Sddc.ACCOUNT_LINK_STATE_DELAYED
-Sddc.ACCOUNT_LINK_STATE_LINKED
-Sddc.ACCOUNT_LINK_STATE_UNLINKED
+- +
- +
-
-Account linking state of the sddc
-- sddc_access_state (
strorNone) – Describes the access state of sddc, valid state is DISABLED or -ENABLED
- - resource_config (
AwsSddcResourceConfigorNone) –
+
+Account linking state of the sddc
+
+ sddc_access_state (
strorNone) – Describes the access state of sddc, valid state is DISABLED or +ENABLED
+resource_config (
AwsSddcResourceConfigorNone) –
+- updated (
com.vmware.vmc.model_client.Sddc(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, name=None, sddc_state=None, expiration_date=None, org_id=None, sddc_type=None, provider=None, account_link_state=None, sddc_access_state=None, resource_config=None)¶
-
-class
com.vmware.vmc.model_client.SddcAllocatePublicIpSpec(count=None, private_ips=None, names=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- count (
long) –
- - private_ips (
listofstrorNone) – List of workload VM private IPs to be assigned the public IP just -allocated.
- - names (
listofstrorNone) – List of names for the workload VM public IP assignment.
+ - Parameters +
-
+
count (
long) –
+private_ips (
listofstrorNone) – List of workload VM private IPs to be assigned the public IP just +allocated.
+names (
listofstrorNone) – List of names for the workload VM public IP assignment.
-
+
+- count (
com.vmware.vmc.model_client.SddcAllocatePublicIpSpec(count=None, private_ips=None, names=None)¶
-
-class
com.vmware.vmc.model_client.SddcConfig(storage_capacity=None, name=None, account_link_sddc_config=None, vpc_cidr=None, num_hosts=None, sddc_type=None, vxlan_subnet=None, account_link_config=None, provider='SddcConfig', skip_creating_vxlan=None, sso_domain=None, sddc_template_id=None, deployment_type=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- storage_capacity (
longorNone) – The storage capacity value to be requested for the sddc primary +-
+
- Parameters +
-
+
storage_capacity (
longorNone) – The storage capacity value to be requested for the sddc primary cluster, in GiBs. If provided, instead of using the direct-attached storage, a capacity value amount of seperable storage will be used. -format: int64
-- name (
str) –
- - account_link_sddc_config (
listofAccountLinkSddcConfigorNone) – A list of the SDDC linking configurations to use.
- - vpc_cidr (
strorNone) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.
- - num_hosts (
long) –
- - sddc_type (
strorNone) – Denotes the sddc type , if the value is null or empty, the type is -considered as default.
- - vxlan_subnet (
strorNone) – VXLAN IP subnet in CIDR for compute gateway
- - account_link_config (
AccountLinkConfigorNone) – The account linking configuration, we will keep this one and remove -accountLinkSddcConfig finally.
- - provider (
str) –Possible values are:
+format: int64
+ name (
str) –
+account_link_sddc_config (
listofAccountLinkSddcConfigorNone) – A list of the SDDC linking configurations to use.
+vpc_cidr (
strorNone) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.
+num_hosts (
long) –
+sddc_type (
strorNone) – Denotes the sddc type , if the value is null or empty, the type is +considered as default.
+vxlan_subnet (
strorNone) – VXLAN IP subnet in CIDR for compute gateway
+account_link_config (
AccountLinkConfigorNone) – The account linking configuration, we will keep this one and remove +accountLinkSddcConfig finally.
+provider (
str) –Possible values are:
Determines what additional properties are available based on cloud provider.
-
-- skip_creating_vxlan (
boolorNone) – skip creating vxlan for compute gateway for SDDC provisioning
- - sso_domain (
strorNone) – The SSO domain name to use for vSphere users. If not specified, -vmc.local will be used.
- - sddc_template_id (
strorNone) – If provided, configuration from the template will applied to the -provisioned SDDC. format: UUID
- - deployment_type (
strorNone) –Possible values are:
+
+ skip_creating_vxlan (
boolorNone) – skip creating vxlan for compute gateway for SDDC provisioning
+sso_domain (
strorNone) – The SSO domain name to use for vSphere users. If not specified, +vmc.local will be used.
+sddc_template_id (
strorNone) – If provided, configuration from the template will applied to the +provisioned SDDC. format: UUID
+deployment_type (
strorNone) –Possible values are:
Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is SingleAZ.
-
+
+- storage_capacity (
com.vmware.vmc.model_client.SddcConfig(storage_capacity=None, name=None, account_link_sddc_config=None, vpc_cidr=None, num_hosts=None, sddc_type=None, vxlan_subnet=None, account_link_config=None, provider='SddcConfig', skip_creating_vxlan=None, sso_domain=None, sddc_template_id=None, deployment_type=None)¶
-
+
@@ -5215,337 +4669,294 @@ SingleAZ.
-
-class
com.vmware.vmc.model_client.SddcId(sddc_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: sddc_id ( -strorNone) – Sddc ID-
+
- Parameters +
sddc_id (
+strorNone) – Sddc ID
+
-
-class
com.vmware.vmc.model_client.SddcLinkConfig(customer_subnet_ids=None, connected_account_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- customer_subnet_ids (
listofstrorNone) –
- - connected_account_id (
strorNone) – Determines which connected customer account to link to
+ - Parameters +
-
+
customer_subnet_ids (
listofstrorNone) –
+connected_account_id (
strorNone) – Determines which connected customer account to link to
-
+
+- customer_subnet_ids (
com.vmware.vmc.model_client.SddcId(sddc_id=None)¶
com.vmware.vmc.model_client.SddcLinkConfig(customer_subnet_ids=None, connected_account_id=None)¶
-
-class
com.vmware.vmc.model_client.SddcManifest(vmc_version=None, glcm_bundle=None, pop_info=None, vmc_internal_version=None, esx_ami=None, esx_nsxt_ami=None, metadata=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDescribes software components of the installed SDDC
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- vmc_version (
strorNone) – the vmcVersion of the sddc for display
- - glcm_bundle (
GlcmBundleorNone) –
- - pop_info (
PopInfoorNone) –
- - vmc_internal_version (
strorNone) – the vmcInternalVersion of the sddc for internal use
- - esx_ami (
AmiInfoorNone) –
- - esx_nsxt_ami (
AmiInfoorNone) –
- - metadata (
MetadataorNone) –
+ - Parameters +
-
+
vmc_version (
strorNone) – the vmcVersion of the sddc for display
+glcm_bundle (
GlcmBundleorNone) –
+pop_info (
PopInfoorNone) –
+vmc_internal_version (
strorNone) – the vmcInternalVersion of the sddc for internal use
+esx_ami (
AmiInfoorNone) –
+esx_nsxt_ami (
AmiInfoorNone) –
+metadata (
MetadataorNone) –
-
+
+- vmc_version (
com.vmware.vmc.model_client.SddcManifest(vmc_version=None, glcm_bundle=None, pop_info=None, vmc_internal_version=None, esx_ami=None, esx_nsxt_ami=None, metadata=None)¶
-
-class
com.vmware.vmc.model_client.SddcNetwork(subnets=None, cgw_name=None, name=None, l2_extension=None, cgw_id=None, dhcp_configs=None, id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructLogical network.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- subnets (
SddcNetworkAddressGroupsorNone) – Network address groups for routed logical networks.
- - cgw_name (
strorNone) – Name of the compute gateway to which the logical network is -attached.
- - name (
str) – Name of logical network. Length needs to be between 1-35 -characters.
- - l2_extension (
L2ExtensionorNone) – Layer 2 extension for extended logical networks.
- - cgw_id (
str) – ID of the compute gateway edge to which the logical network is -attached.
- - dhcp_configs (
SddcNetworkDhcpConfigorNone) – DHCP configuration for routed logical networks.
- - id (
strorNone) – ID of logical network.
+ - Parameters +
-
+
subnets (
SddcNetworkAddressGroupsorNone) – Network address groups for routed logical networks.
+cgw_name (
strorNone) – Name of the compute gateway to which the logical network is +attached.
+name (
str) – Name of logical network. Length needs to be between 1-35 +characters.
+l2_extension (
L2ExtensionorNone) – Layer 2 extension for extended logical networks.
+cgw_id (
str) – ID of the compute gateway edge to which the logical network is +attached.
+dhcp_configs (
SddcNetworkDhcpConfigorNone) – DHCP configuration for routed logical networks.
+id (
strorNone) – ID of logical network.
-
+
+- subnets (
com.vmware.vmc.model_client.SddcNetwork(subnets=None, cgw_name=None, name=None, l2_extension=None, cgw_id=None, dhcp_configs=None, id=None)¶
-
-class
com.vmware.vmc.model_client.SddcNetworkAddressGroup(prefix_length=None, primary_address=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructLogical Network address group.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- prefix_length (
strorNone) – Prefix length of logical network.
- - primary_address (
strorNone) – Primary address for logical network.
+ - Parameters +
-
+
prefix_length (
strorNone) – Prefix length of logical network.
+primary_address (
strorNone) – Primary address for logical network.
-
+
+- prefix_length (
com.vmware.vmc.model_client.SddcNetworkAddressGroup(prefix_length=None, primary_address=None)¶
-
-class
com.vmware.vmc.model_client.SddcNetworkAddressGroups(address_groups=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructLogical network address groups.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: address_groups ( -listofSddcNetworkAddressGrouporNone) – List of logical network address groups.-
+
- Parameters +
address_groups (
+listofSddcNetworkAddressGrouporNone) – List of logical network address groups.
+
com.vmware.vmc.model_client.SddcNetworkAddressGroups(address_groups=None)¶
-
-class
com.vmware.vmc.model_client.SddcNetworkDhcpConfig(ip_pools=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDHCP configuration for the logical network.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: ip_pools ( -listofSddcNetworkDhcpIpPoolorNone) – List of IP pools in DHCP configuration.-
+
- Parameters +
ip_pools (
+listofSddcNetworkDhcpIpPoolorNone) – List of IP pools in DHCP configuration.
+
com.vmware.vmc.model_client.SddcNetworkDhcpConfig(ip_pools=None)¶
-
-class
com.vmware.vmc.model_client.SddcNetworkDhcpIpPool(ip_range=None, domain_name=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDHCP IP pool for logical network.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- ip_range (
strorNone) – IP range for DHCP IP pool.
- - domain_name (
strorNone) – DNS domain name.
+ - Parameters +
-
+
ip_range (
strorNone) – IP range for DHCP IP pool.
+domain_name (
strorNone) – DNS domain name.
-
+
+- ip_range (
com.vmware.vmc.model_client.SddcNetworkDhcpIpPool(ip_range=None, domain_name=None)¶
-
-class
com.vmware.vmc.model_client.SddcPatchRequest(name=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructPatch request body for SDDC
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: name ( -strorNone) – The new name of the SDDC to be changed to.-
+
- Parameters +
name (
+strorNone) – The new name of the SDDC to be changed to.
+
com.vmware.vmc.model_client.SddcPatchRequest(name=None)¶
-
-class
com.vmware.vmc.model_client.SddcPublicIp(public_ip=None, name=None, allocation_id=None, dnat_rule_id=None, associated_private_ip=None, snat_rule_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- public_ip (
str) –
- - name (
strorNone) –
- - allocation_id (
strorNone) –
- - dnat_rule_id (
strorNone) –
- - associated_private_ip (
strorNone) –
- - snat_rule_id (
strorNone) –
+ - Parameters +
-
+
public_ip (
str) –
+name (
strorNone) –
+allocation_id (
strorNone) –
+dnat_rule_id (
strorNone) –
+associated_private_ip (
strorNone) –
+snat_rule_id (
strorNone) –
-
+
+- public_ip (
com.vmware.vmc.model_client.SddcPublicIp(public_ip=None, name=None, allocation_id=None, dnat_rule_id=None, associated_private_ip=None, snat_rule_id=None)¶
-
-class
com.vmware.vmc.model_client.SddcResourceConfig(mgmt_appliance_network_name=None, nsxt=None, mgw_id=None, nsx_mgr_url=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, management_ds=None, nsx_api_public_endpoint_url=None, custom_properties=None, cloud_password=None, provider='SddcResourceConfig', clusters=None, vc_management_ip=None, sddc_networks=None, cloud_username=None, esx_hosts=None, nsx_mgr_management_ip=None, vc_instance_id=None, esx_cluster_id=None, vc_public_ip=None, skip_creating_vxlan=None, vc_url=None, sddc_manifest=None, vxlan_subnet=None, cloud_user_group=None, management_rp=None, witness_availability_zone=None, pop_agent_xeni_connection=None, nsx_controller_ips=None, esx_host_subnet=None, sso_domain=None, deployment_type=None, nsxt_addons=None, dns_with_management_vm_private_ip=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- mgmt_appliance_network_name (
strorNone) – Name for management appliance network.
- - nsxt (
boolorNone) – if true, NSX-T UI is enabled.
- - mgw_id (
strorNone) – Management Gateway Id
- - nsx_mgr_url (
strorNone) – URL of the NSX Manager
- - psc_management_ip (
strorNone) – PSC internal management IP
- - psc_url (
strorNone) – URL of the PSC server
- - cgws (
listofstrorNone) –
- - availability_zones (
listofstrorNone) – Availability zones over which esx hosts are provisioned. MultiAZ +-
+
- Parameters +
-
+
mgmt_appliance_network_name (
strorNone) – Name for management appliance network.
+nsxt (
boolorNone) – if true, NSX-T UI is enabled.
+mgw_id (
strorNone) – Management Gateway Id
+nsx_mgr_url (
strorNone) – URL of the NSX Manager
+psc_management_ip (
strorNone) – PSC internal management IP
+psc_url (
strorNone) – URL of the PSC server
+cgws (
listofstrorNone) –
+availability_zones (
listofstrorNone) – Availability zones over which esx hosts are provisioned. MultiAZ SDDCs will have hosts provisioned over two availability zones while -SingleAZ SDDCs will provision over one.
-- management_ds (
strorNone) – The ManagedObjectReference of the management Datastore
- - nsx_api_public_endpoint_url (
strorNone) – nsx api entire base url
- - custom_properties ((
dictofstrandstr) orNone) –
- - cloud_password (
strorNone) – Password for vCenter SDDC administrator
- - provider (
str) –Possible values are:
+SingleAZ SDDCs will provision over one.
+ management_ds (
strorNone) – The ManagedObjectReference of the management Datastore
+nsx_api_public_endpoint_url (
strorNone) – nsx api entire base url
+custom_properties ((
dictofstrandstr) orNone) –
+cloud_password (
strorNone) – Password for vCenter SDDC administrator
+provider (
str) –Possible values are:
-
-Discriminator for additional properties
-- clusters (
listofvmware.vapi.struct.VapiStructorNone) – List of clusters in the SDDC. -When clients pass a value of this class as a parameter, the -attribute must contain all the attributes defined in -Cluster. When methods return a value of this class as a -return value, the attribute will contain all the attributes defined -inCluster.
- - vc_management_ip (
strorNone) – vCenter internal management IP
- - sddc_networks (
listofstrorNone) –
- - cloud_username (
strorNone) – Username for vCenter SDDC administrator
- - esx_hosts (
listofAwsEsxHostorNone) –
- - nsx_mgr_management_ip (
strorNone) – NSX Manager internal management IP
- - vc_instance_id (
strorNone) – unique id of the vCenter server
- - esx_cluster_id (
strorNone) – Cluster Id to add ESX workflow
- - vc_public_ip (
strorNone) – vCenter public IP
- - skip_creating_vxlan (
boolorNone) – skip creating vxlan for compute gateway for SDDC provisioning
- - vc_url (
strorNone) – URL of the vCenter server
- - sddc_manifest (
SddcManifestorNone) –
- - vxlan_subnet (
strorNone) – VXLAN IP subnet
- - cloud_user_group (
strorNone) – Group name for vCenter SDDC administrator
- - management_rp (
strorNone) –
- - witness_availability_zone (
strorNone) – Availability zone where the witness node is provisioned for a -MultiAZ SDDC. This is null for a SingleAZ SDDC.
- - pop_agent_xeni_connection (
PopAgentXeniConnectionorNone) –
- - nsx_controller_ips (
listofstrorNone) – List of Controller IPs
- - esx_host_subnet (
strorNone) – ESX host subnet
- - sso_domain (
strorNone) – The SSO domain name to use for vSphere users
- - deployment_type (
strorNone) –Possible values are:
++Discriminator for additional properties
+
+ clusters (
listofClusterorNone) – List of clusters in the SDDC.
+vc_management_ip (
strorNone) – vCenter internal management IP
+sddc_networks (
listofstrorNone) –
+cloud_username (
strorNone) – Username for vCenter SDDC administrator
+esx_hosts (
listofAwsEsxHostorNone) –
+nsx_mgr_management_ip (
strorNone) – NSX Manager internal management IP
+vc_instance_id (
strorNone) – unique id of the vCenter server
+esx_cluster_id (
strorNone) – Cluster Id to add ESX workflow
+vc_public_ip (
strorNone) – vCenter public IP
+skip_creating_vxlan (
boolorNone) – skip creating vxlan for compute gateway for SDDC provisioning
+vc_url (
strorNone) – URL of the vCenter server
+sddc_manifest (
SddcManifestorNone) –
+vxlan_subnet (
strorNone) – VXLAN IP subnet
+cloud_user_group (
strorNone) – Group name for vCenter SDDC administrator
+management_rp (
strorNone) –
+witness_availability_zone (
strorNone) – Availability zone where the witness node is provisioned for a +MultiAZ SDDC. This is null for a SingleAZ SDDC.
+pop_agent_xeni_connection (
PopAgentXeniConnectionorNone) –
+nsx_controller_ips (
listofstrorNone) – List of Controller IPs
+esx_host_subnet (
strorNone) – ESX host subnet
+sso_domain (
strorNone) – The SSO domain name to use for vSphere users
+deployment_type (
strorNone) –Possible values are:
-
-Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.
-- nsxt_addons (
NsxtAddonsorNone) –
- - dns_with_management_vm_private_ip (
boolorNone) – if true, use the private IP addresses to register DNS records for -the management VMs
+
+Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.
+
+ nsxt_addons (
NsxtAddonsorNone) –
+dns_with_management_vm_private_ip (
boolorNone) – if true, use the private IP addresses to register DNS records for +the management VMs
+- mgmt_appliance_network_name (
com.vmware.vmc.model_client.SddcResourceConfig(mgmt_appliance_network_name=None, nsxt=None, mgw_id=None, nsx_mgr_url=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, management_ds=None, nsx_api_public_endpoint_url=None, custom_properties=None, cloud_password=None, provider='SddcResourceConfig', clusters=None, vc_management_ip=None, sddc_networks=None, cloud_username=None, esx_hosts=None, nsx_mgr_management_ip=None, vc_instance_id=None, esx_cluster_id=None, vc_public_ip=None, skip_creating_vxlan=None, vc_url=None, sddc_manifest=None, vxlan_subnet=None, cloud_user_group=None, management_rp=None, witness_availability_zone=None, pop_agent_xeni_connection=None, nsx_controller_ips=None, esx_host_subnet=None, sso_domain=None, deployment_type=None, nsxt_addons=None, dns_with_management_vm_private_ip=None)¶
-
+
@@ -5553,1383 +4964,1259 @@ the management VMs
-
-class
com.vmware.vmc.model_client.SddcStateRequest(sddcs=None, states=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- sddcs (
listofstrorNone) –
- - states (
listofstrorNone) –Possible values are:
+-
+
- Parameters +
-
+
sddcs (
listofstrorNone) –
+states (
listofstrorNone) –Possible values are:
-
+
+- sddcs (
com.vmware.vmc.model_client.SddcStateRequest(sddcs=None, states=None)¶
-
-class
com.vmware.vmc.model_client.SddcTemplate(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, account_link_sddc_configs=None, state=None, network_template=None, name=None, source_sddc_id=None, org_id=None, sddc=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- updated (
datetime.datetime) –
- - user_id (
str) – User id that last updated this record
- - updated_by_user_id (
str) – User id that last updated this record
- - created (
datetime.datetime) –
- - version (
long) – Version of this entity format: int32
- - updated_by_user_name (
strorNone) – User name that last updated this record
- - user_name (
str) – User name that last updated this record
- - id (
str) – Unique ID for this entity
- - account_link_sddc_configs (
listofAccountLinkSddcConfigorNone) – A list of the SDDC linking configurations to use.
- - state (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
updated (
datetime.datetime) –
+user_id (
str) – User id that last updated this record
+updated_by_user_id (
str) – User id that last updated this record
+created (
datetime.datetime) –
+version (
long) – Version of this entity format: int32
+updated_by_user_name (
strorNone) – User name that last updated this record
+user_name (
str) – User name that last updated this record
+id (
str) – Unique ID for this entity
+account_link_sddc_configs (
listofAccountLinkSddcConfigorNone) – A list of the SDDC linking configurations to use.
+state (
strorNone) –Possible values are:
-
-- network_template (
NetworkTemplateorNone) –
- - name (
strorNone) – name for SDDC configuration template
- - source_sddc_id (
strorNone) –
- - org_id (
strorNone) –
- - sddc (
SddcorNone) –
+
+ network_template (
NetworkTemplateorNone) –
+name (
strorNone) – name for SDDC configuration template
+source_sddc_id (
strorNone) –
+org_id (
strorNone) –
+sddc (
SddcorNone) –
+- updated (
com.vmware.vmc.model_client.SddcTemplate(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, account_link_sddc_configs=None, state=None, network_template=None, name=None, source_sddc_id=None, org_id=None, sddc=None)¶
-
-class
com.vmware.vmc.model_client.SecondaryAddresses(type=None, ip_address=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructSecondary IP addresses of the NSX Edge vnic address group. These are used for NAT, LB, VPN etc. Optional.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- type (
strorNone) –
- - ip_address (
listofstrorNone) – List of IP addresses.
+ - Parameters +
-
+
type (
strorNone) –
+ip_address (
listofstrorNone) – List of IP addresses.
-
+
+- type (
com.vmware.vmc.model_client.SecondaryAddresses(type=None, ip_address=None)¶
-
-class
com.vmware.vmc.model_client.ServiceError(default_message=None, original_service=None, localized_message=None, original_service_error_code=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDetailed service errors associated with a task.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- default_message (
strorNone) – Error message in English.
- - original_service (
str) – The original service name of the error.
- - localized_message (
strorNone) – The localized message.
- - original_service_error_code (
str) – The original error code of the service.
+ - Parameters +
-
+
default_message (
strorNone) – Error message in English.
+original_service (
str) – The original service name of the error.
+localized_message (
strorNone) – The localized message.
+original_service_error_code (
str) – The original error code of the service.
-
+
+- default_message (
com.vmware.vmc.model_client.ServiceError(default_message=None, original_service=None, localized_message=None, original_service_error_code=None)¶
-
-class
com.vmware.vmc.model_client.Site(password=None, user_id=None, name=None, rx_bytes_on_local_subnet=None, secure_traffic=None, established_date=None, failure_message=None, dropped_tx_packets=None, dropped_rx_packets=None, tunnel_status=None, tx_bytes_from_local_subnet=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- password (
strorNone) – Site password.
- - user_id (
strorNone) – Site user id.
- - name (
strorNone) – Unique name for the site getting configured.
- - rx_bytes_on_local_subnet (
longorNone) – Bytes received on local network. format: int64 +-
+
- Parameters +
-
+
password (
strorNone) – Site password.
+user_id (
strorNone) – Site user id.
+name (
strorNone) – Unique name for the site getting configured.
+rx_bytes_on_local_subnet (
longorNone) – Bytes received on local network. format: int64 This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.
-- secure_traffic (
boolorNone) – Enable/disable encription.
- - established_date (
strorNone) – Date tunnel was established. +it is present in a request to server it will be ignored.
+ secure_traffic (
boolorNone) – Enable/disable encription.
+established_date (
strorNone) – Date tunnel was established. This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.
-- failure_message (
strorNone) – failure message. +it is present in a request to server it will be ignored.
+ failure_message (
strorNone) – failure message. This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.
-- dropped_tx_packets (
strorNone) – Number of transmitted packets dropped. +it is present in a request to server it will be ignored.
+ dropped_tx_packets (
strorNone) – Number of transmitted packets dropped. This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.
-- dropped_rx_packets (
strorNone) – Number of received packets dropped. +it is present in a request to server it will be ignored.
+ dropped_rx_packets (
strorNone) – Number of received packets dropped. This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.
-- tunnel_status (
strorNone) –Possible values are:
+it is present in a request to server it will be ignored.
+ tunnel_status (
strorNone) –Possible values are:
-
+Site tunnel status.Site tunnel status.
+This attribute may be present in responses from the server, but if it is present in a request to server it will be ignored.
-
-- tx_bytes_from_local_subnet (
longorNone) – Bytes transmitted from local subnet. format: int64 +
+ tx_bytes_from_local_subnet (
longorNone) – Bytes transmitted from local subnet. format: int64 This attribute may be present in responses from the server, but if -it is present in a request to server it will be ignored.
+it is present in a request to server it will be ignored.
+- password (
com.vmware.vmc.model_client.Site(password=None, user_id=None, name=None, rx_bytes_on_local_subnet=None, secure_traffic=None, established_date=None, failure_message=None, dropped_tx_packets=None, dropped_rx_packets=None, tunnel_status=None, tx_bytes_from_local_subnet=None)¶
-
-class
com.vmware.vmc.model_client.Sites(sites=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructL2 VPN sites.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: sites ( -listofNsxsiteorNone) –-
+
- Parameters +
sites (
+listofNsxsiteorNone) –
+
com.vmware.vmc.model_client.Sites(sites=None)¶
-
-class
com.vmware.vmc.model_client.SslvpnDashboardStats(active_clients=None, sslvpn_bytes_in=None, auth_failures=None, sessions_created=None, sslvpn_bytes_out=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDashboard Statistics data for SSL VPN.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- active_clients (
listofDashboardStatorNone) – Number of active clients.
- - sslvpn_bytes_in (
listofDashboardStatorNone) – Rx bytes received for SSL VPN.
- - auth_failures (
listofDashboardStatorNone) – Number of authentication failures.
- - sessions_created (
listofDashboardStatorNone) – Number of SSL VPN sessions created.
- - sslvpn_bytes_out (
listofDashboardStatorNone) – Tx bytes transmitted for SSL VPN.
+ - Parameters +
-
+
active_clients (
listofDashboardStatorNone) – Number of active clients.
+sslvpn_bytes_in (
listofDashboardStatorNone) – Rx bytes received for SSL VPN.
+auth_failures (
listofDashboardStatorNone) – Number of authentication failures.
+sessions_created (
listofDashboardStatorNone) – Number of SSL VPN sessions created.
+sslvpn_bytes_out (
listofDashboardStatorNone) – Tx bytes transmitted for SSL VPN.
-
+
+- active_clients (
com.vmware.vmc.model_client.SslvpnDashboardStats(active_clients=None, sslvpn_bytes_in=None, auth_failures=None, sessions_created=None, sslvpn_bytes_out=None)¶
-
-class
com.vmware.vmc.model_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.model_client.StubFactory(stub_config)¶
-
-class
com.vmware.vmc.model_client.SubInterface(index=None, tunnel_id=None, name=None, address_groups=None, vlan_id=None, label=None, logical_switch_name=None, is_connected=None, mtu=None, logical_switch_id=None, enable_send_redirects=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNSX Edge sub interface configuration details. Sub interfaces are created on a trunk interface.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- index (
longorNone) – Index of the sub interface assigned by NSX Manager. Min value is 10 -and max value is 4103. format: int32
- - tunnel_id (
long) – Valid values for tunnel ID are min 1 to max 4093. Required. format: -int32
- - name (
strorNone) – Name of the sub interface. Required.
- - address_groups (
EdgeVnicAddressGroupsorNone) – Address group configuration of the sub interface.
- - vlan_id (
longorNone) – VLAN ID of the virtual LAN used by this sub interface. VLAN IDs can -range from 0 to 4094. format: int32
- - label (
strorNone) – Sub interface label of format vNic_{index} provided by NSX Manager. -Read only.
- - logical_switch_name (
strorNone) – Name of the logical switch connected to this sub interface.
- - is_connected (
boolorNone) – Value is true if the sub interface is connected to a logical -switch, standard portgroup or distributed portgroup.
- - mtu (
longorNone) – MTU value of the sub interface. This value would be the least mtu +-
+
- Parameters +
-
+
index (
longorNone) – Index of the sub interface assigned by NSX Manager. Min value is 10 +and max value is 4103. format: int32
+tunnel_id (
long) – Valid values for tunnel ID are min 1 to max 4093. Required. format: +int32
+name (
strorNone) – Name of the sub interface. Required.
+address_groups (
EdgeVnicAddressGroupsorNone) – Address group configuration of the sub interface.
+vlan_id (
longorNone) – VLAN ID of the virtual LAN used by this sub interface. VLAN IDs can +range from 0 to 4094. format: int32
+label (
strorNone) – Sub interface label of format vNic_{index} provided by NSX Manager. +Read only.
+logical_switch_name (
strorNone) – Name of the logical switch connected to this sub interface.
+is_connected (
boolorNone) – Value is true if the sub interface is connected to a logical +switch, standard portgroup or distributed portgroup.
+mtu (
longorNone) – MTU value of the sub interface. This value would be the least mtu for all the trunk interfaces of the NSX Edge. Default is 1500. -format: int32
-- logical_switch_id (
strorNone) – ID of the logical switch connected to this sub interface.
- - enable_send_redirects (
boolorNone) – Value is true if send redirects is enabled. Enable ICMP redirect to -convey routing information to hosts.
+format: int32
+ logical_switch_id (
strorNone) – ID of the logical switch connected to this sub interface.
+enable_send_redirects (
boolorNone) – Value is true if send redirects is enabled. Enable ICMP redirect to +convey routing information to hosts.
+- index (
com.vmware.vmc.model_client.SubInterface(index=None, tunnel_id=None, name=None, address_groups=None, vlan_id=None, label=None, logical_switch_name=None, is_connected=None, mtu=None, logical_switch_id=None, enable_send_redirects=None)¶
-
-class
com.vmware.vmc.model_client.SubInterfaces(sub_interfaces=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: sub_interfaces ( -listofSubInterfaceorNone) – List of sub interfaces.-
+
- Parameters +
sub_interfaces (
+listofSubInterfaceorNone) – List of sub interfaces.
+
com.vmware.vmc.model_client.SubInterfaces(sub_interfaces=None)¶
-
-class
com.vmware.vmc.model_client.SubnetInfo(compatible=None, connected_account_id=None, region_name=None, availability_zone=None, subnet_id=None, subnet_cidr_block=None, note=None, vpc_id=None, vpc_cidr_block=None, name=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- compatible (
boolorNone) – Is this customer subnet compatible with the SDDC?
- - connected_account_id (
strorNone) – The ID of the connected account this subnet is from.
- - region_name (
strorNone) – The region this subnet is from.
- - availability_zone (
strorNone) – The availability zone (customer-centric) this subnet is in.
- - subnet_id (
strorNone) – The ID of the subnet.
- - subnet_cidr_block (
strorNone) – The CIDR block of the subnet.
- - note (
strorNone) – Why a subnet is marked as not compatible. May be blank if -compatible.
- - vpc_id (
strorNone) – The ID of the VPC this subnet resides in.
- - vpc_cidr_block (
strorNone) – The CIDR block of the VPC containing this subnet.
- - name (
strorNone) – The name of the subnet. This is either the tagged name or the -default AWS id it was given.
+ - Parameters +
-
+
compatible (
boolorNone) – Is this customer subnet compatible with the SDDC?
+connected_account_id (
strorNone) – The ID of the connected account this subnet is from.
+region_name (
strorNone) – The region this subnet is from.
+availability_zone (
strorNone) – The availability zone (customer-centric) this subnet is in.
+subnet_id (
strorNone) – The ID of the subnet.
+subnet_cidr_block (
strorNone) – The CIDR block of the subnet.
+note (
strorNone) – Why a subnet is marked as not compatible. May be blank if +compatible.
+vpc_id (
strorNone) – The ID of the VPC this subnet resides in.
+vpc_cidr_block (
strorNone) – The CIDR block of the VPC containing this subnet.
+name (
strorNone) – The name of the subnet. This is either the tagged name or the +default AWS id it was given.
-
+
+- compatible (
com.vmware.vmc.model_client.SubnetInfo(compatible=None, connected_account_id=None, region_name=None, availability_zone=None, subnet_id=None, subnet_cidr_block=None, note=None, vpc_id=None, vpc_cidr_block=None, name=None)¶
-
-class
com.vmware.vmc.model_client.Subnets(subnets=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+‘0.0.0.0/0’ (any) +- - - Parameters: subnets ( -listofstrorNone) – List of subnets for which IPsec VPN is configured. Subnets should +-
+
- Parameters +
subnets (
listofstrorNone) – List of subnets for which IPsec VPN is configured. Subnets should be network address specified in CIDR format and can accept -‘0.0.0.0/0’ (any)
+
com.vmware.vmc.model_client.Subnets(subnets=None)¶
-
-class
com.vmware.vmc.model_client.SubscriptionDetails(status=None, anniversary_billing_date=None, end_date=None, auto_renewed_allowed=None, description=None, commitment_term=None, csp_subscription_id=None, billing_subscription_id=None, commitment_term_uom=None, offer_version=None, region=None, offer_name=None, offer_type=None, start_date=None, quantity=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructdetails of a subscription
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- status (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
status (
strorNone) –Possible values are:
-
-- anniversary_billing_date (
strorNone) –
- - end_date (
strorNone) –
- - auto_renewed_allowed (
strorNone) –
- - description (
strorNone) –
- - commitment_term (
strorNone) –
- - csp_subscription_id (
strorNone) –
- - billing_subscription_id (
strorNone) –
- - commitment_term_uom (
strorNone) – unit of measurment for commitment term
- - offer_version (
strorNone) –
- - region (
strorNone) –
- - offer_name (
strorNone) –
- - offer_type (
OfferTypeorNone) –
- - start_date (
strorNone) –
- - quantity (
strorNone) –
+
+ anniversary_billing_date (
strorNone) –
+end_date (
strorNone) –
+auto_renewed_allowed (
strorNone) –
+description (
strorNone) –
+commitment_term (
strorNone) –
+csp_subscription_id (
strorNone) –
+billing_subscription_id (
strorNone) –
+commitment_term_uom (
strorNone) – unit of measurment for commitment term
+offer_version (
strorNone) –
+region (
strorNone) –
+offer_name (
strorNone) –
+offer_type (
OfferTypeorNone) –
+start_date (
strorNone) –
+quantity (
strorNone) –
+- status (
com.vmware.vmc.model_client.SubscriptionDetails(status=None, anniversary_billing_date=None, end_date=None, auto_renewed_allowed=None, description=None, commitment_term=None, csp_subscription_id=None, billing_subscription_id=None, commitment_term_uom=None, offer_version=None, region=None, offer_name=None, offer_type=None, start_date=None, quantity=None)¶
-
-
STATUS_PENDING_PROVISIONING= 'PENDING_PROVISIONING'¶
+
STATUS_PENDING_PROVISIONING = 'PENDING_PROVISIONING'¶
-
-class
com.vmware.vmc.model_client.SubscriptionProducts(product=None, types=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructDetails of products that are available for purchase.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- product (
strorNone) – The name of the product
- - types (
listofstrorNone) – A list of different types/version for the product.
+ - Parameters +
-
+
product (
strorNone) – The name of the product
+types (
listofstrorNone) – A list of different types/version for the product.
-
+
+- product (
com.vmware.vmc.model_client.SubscriptionProducts(product=None, types=None)¶
-
-class
com.vmware.vmc.model_client.SubscriptionRequest(product=None, product_type=None, product_id=None, region=None, commitment_term=None, offer_context_id=None, offer_version=None, offer_name=None, quantity=None, type=None, price=None, product_charge_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- product (
strorNone) – The product for which subscription needs to be created. Refer -/vmc/api/orgs/{orgId}/products.
- - product_type (
str) – Old identifier for product. *Deprecarted*. See product and type
- - product_id (
strorNone) –
- - region (
str) –
- - commitment_term (
str) –
- - offer_context_id (
strorNone) –
- - offer_version (
str) –
- - offer_name (
str) –
- - quantity (
long) –
- - type (
strorNone) – The type of the product for which the subscription needs to be -created.
- - price (
longorNone) –
- - product_charge_id (
strorNone) –
+ - Parameters +
-
+
product (
strorNone) – The product for which subscription needs to be created. Refer +/vmc/api/orgs/{orgId}/products.
+product_type (
str) – Old identifier for product. *Deprecarted*. See product and type
+product_id (
strorNone) –
+region (
str) –
+commitment_term (
str) –
+offer_context_id (
strorNone) –
+offer_version (
str) –
+offer_name (
str) –
+quantity (
long) –
+type (
strorNone) – The type of the product for which the subscription needs to be +created.
+price (
longorNone) –
+product_charge_id (
strorNone) –
-
+
+- product (
com.vmware.vmc.model_client.SubscriptionRequest(product=None, product_type=None, product_id=None, region=None, commitment_term=None, offer_context_id=None, offer_version=None, offer_name=None, quantity=None, type=None, price=None, product_charge_id=None)¶
-
-class
com.vmware.vmc.model_client.SupportWindow(start_day=None, seats=None, sddcs=None, duration_hours=None, start_hour=None, support_window_id=None, metadata=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- start_day (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
start_day (
strorNone) –Possible values are:
-
-- seats (
longorNone) –
- - sddcs (
listofstrorNone) – SDDCs in this window format: UUID
- - duration_hours (
longorNone) –
- - start_hour (
longorNone) –
- - support_window_id (
strorNone) –
- - metadata (
vmware.vapi.struct.VapiStructorNone) –
+
+ seats (
longorNone) –
+sddcs (
listofstrorNone) – SDDCs in this window format: UUID
+duration_hours (
longorNone) –
+start_hour (
longorNone) –
+support_window_id (
strorNone) –
+metadata (
vmware.vapi.struct.VapiStructorNone) –
+- start_day (
com.vmware.vmc.model_client.SupportWindow(start_day=None, seats=None, sddcs=None, duration_hours=None, start_hour=None, support_window_id=None, metadata=None)¶
-
-class
com.vmware.vmc.model_client.SupportWindowId(window_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: window_id ( -strorNone) – Support Window ID-
+
- Parameters +
window_id (
+strorNone) – Support Window ID
+
com.vmware.vmc.model_client.SupportWindowId(window_id=None)¶
-
-class
com.vmware.vmc.model_client.Task(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, status=None, localized_error_message=None, resource_id=None, parent_task_id=None, task_version=None, correlation_id=None, start_resource_entity_version=None, sub_status=None, task_type=None, start_time=None, task_progress_phases=None, error_message=None, org_id=None, end_resource_entity_version=None, service_errors=None, org_type=None, estimated_remaining_minutes=None, params=None, progress_percent=None, phase_in_progress=None, resource_type=None, end_time=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- updated (
datetime.datetime) –
- - user_id (
str) – User id that last updated this record
- - updated_by_user_id (
str) – User id that last updated this record
- - created (
datetime.datetime) –
- - version (
long) – Version of this entity format: int32
- - updated_by_user_name (
strorNone) – User name that last updated this record
- - user_name (
str) – User name that last updated this record
- - id (
str) – Unique ID for this entity
- - status (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
updated (
datetime.datetime) –
+user_id (
str) – User id that last updated this record
+updated_by_user_id (
str) – User id that last updated this record
+created (
datetime.datetime) –
+version (
long) – Version of this entity format: int32
+updated_by_user_name (
strorNone) – User name that last updated this record
+user_name (
str) – User name that last updated this record
+id (
str) – Unique ID for this entity
+status (
strorNone) –Possible values are:
-
-- localized_error_message (
strorNone) –
- - resource_id (
strorNone) – UUID of the resource the task is acting upon
- - parent_task_id (
strorNone) – If this task was created by another task - this provides the -linkage. Mostly for debugging.
- - task_version (
strorNone) –
- - correlation_id (
strorNone) – (Optional) Client provided uniqifier to make task creation +
+ localized_error_message (
strorNone) –
+resource_id (
strorNone) – UUID of the resource the task is acting upon
+parent_task_id (
strorNone) – If this task was created by another task - this provides the +linkage. Mostly for debugging.
+task_version (
strorNone) –
+correlation_id (
strorNone) – (Optional) Client provided uniqifier to make task creation idempotent. Be aware not all tasks support this. For tasks that do - supplying the same correlation Id, for the same task type, within -a predefined window will ensure the operation happens at most once.
-- start_resource_entity_version (
longorNone) – Entity version of the resource at the start of the task. This is -only set for some task types. format: int32
- - sub_status (
strorNone) –
- - task_type (
strorNone) –
- - start_time (
datetime.datetimeorNone) –
- - task_progress_phases (
listofTaskProgressPhaseorNone) – Task progress phases involved in current task execution
- - error_message (
strorNone) –
- - org_id (
strorNone) –
- - end_resource_entity_version (
longorNone) – Entity version of the resource at the end of the task. This is only -set for some task types. format: int32
- - service_errors (
listofServiceErrororNone) – Service errors returned from SDDC services.
- - org_type (
strorNone) –
- - estimated_remaining_minutes (
longorNone) – Estimated remaining time in minute of the task execution, < 0 means -no estimation for the task. format: int32
- - params (
vmware.vapi.struct.VapiStructorNone) –
- - progress_percent (
longorNone) – Estimated progress percentage the task executed format: int32
- - phase_in_progress (
strorNone) – The current in progress phase ID in the task execution, if none in -progress, empty string returned.
- - resource_type (
strorNone) – Type of resource being acted upon
- - end_time (
datetime.datetimeorNone) –
+a predefined window will ensure the operation happens at most once.
+ start_resource_entity_version (
longorNone) – Entity version of the resource at the start of the task. This is +only set for some task types. format: int32
+sub_status (
strorNone) –
+task_type (
strorNone) –
+start_time (
datetime.datetimeorNone) –
+task_progress_phases (
listofTaskProgressPhaseorNone) – Task progress phases involved in current task execution
+error_message (
strorNone) –
+org_id (
strorNone) –
+end_resource_entity_version (
longorNone) – Entity version of the resource at the end of the task. This is only +set for some task types. format: int32
+service_errors (
listofServiceErrororNone) – Service errors returned from SDDC services.
+org_type (
strorNone) –
+estimated_remaining_minutes (
longorNone) – Estimated remaining time in minute of the task execution, < 0 means +no estimation for the task. format: int32
+params (
vmware.vapi.struct.VapiStructorNone) –
+progress_percent (
longorNone) – Estimated progress percentage the task executed format: int32
+phase_in_progress (
strorNone) – The current in progress phase ID in the task execution, if none in +progress, empty string returned.
+resource_type (
strorNone) – Type of resource being acted upon
+end_time (
datetime.datetimeorNone) –
+- updated (
com.vmware.vmc.model_client.Task(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, status=None, localized_error_message=None, resource_id=None, parent_task_id=None, task_version=None, correlation_id=None, start_resource_entity_version=None, sub_status=None, task_type=None, start_time=None, task_progress_phases=None, error_message=None, org_id=None, end_resource_entity_version=None, service_errors=None, org_type=None, estimated_remaining_minutes=None, params=None, progress_percent=None, phase_in_progress=None, resource_type=None, end_time=None)¶
-
-class
com.vmware.vmc.model_client.TaskProgressPhase(id=None, name=None, progress_percent=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructA task progress can be (but does NOT have to be) divided to more meaningful progress phases.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- id (
str) – The identifier of the task progress phase
- - name (
str) – The display name of the task progress phase
- - progress_percent (
long) – The percentage of the phase that has completed format: int32
+ - Parameters +
-
+
id (
str) – The identifier of the task progress phase
+name (
str) – The display name of the task progress phase
+progress_percent (
long) – The percentage of the phase that has completed format: int32
-
+
+- id (
com.vmware.vmc.model_client.TaskProgressPhase(id=None, name=None, progress_percent=None)¶
-
-class
com.vmware.vmc.model_client.TermOfferInstance(description=None, product_type=None, name=None, region=None, commitment_term=None, unit_price=None, currency=None, version=None, offer_context_id=None, product_id=None, product_charge_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructHolder for the term offer instances.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- description (
str) –
- - product_type (
str) –
- - name (
str) –
- - region (
str) –
- - commitment_term (
long) –
- - unit_price (
str) –
- - currency (
str) –
- - version (
str) –
- - offer_context_id (
strorNone) –
- - product_id (
strorNone) –
- - product_charge_id (
strorNone) –
+ - Parameters +
-
+
description (
str) –
+product_type (
str) –
+name (
str) –
+region (
str) –
+commitment_term (
long) –
+unit_price (
str) –
+currency (
str) –
+version (
str) –
+offer_context_id (
strorNone) –
+product_id (
strorNone) –
+product_charge_id (
strorNone) –
-
+
+- description (
com.vmware.vmc.model_client.TermOfferInstance(description=None, product_type=None, name=None, region=None, commitment_term=None, unit_price=None, currency=None, version=None, offer_context_id=None, product_id=None, product_charge_id=None)¶
-
-class
com.vmware.vmc.model_client.TrafficShapingPolicy(burst_size=None, average_bandwidth=None, peak_bandwidth=None, enabled=None, inherited=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- burst_size (
longorNone) –
- - average_bandwidth (
longorNone) –
- - peak_bandwidth (
longorNone) –
- - enabled (
boolorNone) –
- - inherited (
boolorNone) –
+ - Parameters +
-
+
burst_size (
longorNone) –
+average_bandwidth (
longorNone) –
+peak_bandwidth (
longorNone) –
+enabled (
boolorNone) –
+inherited (
boolorNone) –
-
+
+- burst_size (
com.vmware.vmc.model_client.TrafficShapingPolicy(burst_size=None, average_bandwidth=None, peak_bandwidth=None, enabled=None, inherited=None)¶
-
-class
com.vmware.vmc.model_client.UpdateCredentials(username=None, password=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- username (
str) – Username of the credentials
- - password (
str) – Password associated with the credentials
+ - Parameters +
-
+
username (
str) – Username of the credentials
+password (
str) – Password associated with the credentials
-
+
+- username (
com.vmware.vmc.model_client.UpdateCredentials(username=None, password=None)¶
-
-class
com.vmware.vmc.model_client.VmcLocale(locale=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: locale ( -strorNone) – The locale to be used for translating responses for the session-
+
- Parameters +
locale (
+strorNone) – The locale to be used for translating responses for the session
+
com.vmware.vmc.model_client.VmcLocale(locale=None)¶
-
-class
com.vmware.vmc.model_client.Vnic(sub_interfaces=None, address_groups=None, is_connected=None, enable_send_redirects=None, in_shaping_policy=None, label=None, enable_proxy_arp=None, index=None, name=None, mtu=None, fence_parameters=None, mac_addresses=None, out_shaping_policy=None, portgroup_name=None, enable_bridge_mode=None, type=None, portgroup_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructNSX Edge vnic configuration details.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- sub_interfaces (
SubInterfacesorNone) – List of sub interfaces. Sub interfaces can be created only on a -trunk interface.
- - address_groups (
EdgeVnicAddressGroupsorNone) – Address group configuration of the interface.
- - is_connected (
boolorNone) – Value is true if the vnic is connected to a logical switch, -standard portgroup or distributed portgroup.
- - enable_send_redirects (
boolorNone) – Value is true if send redirects is enabled. Enable ICMP redirect to -convey routing information to hosts.
- - in_shaping_policy (
TrafficShapingPolicyorNone) –
- - label (
strorNone) – Interface label of format vNic_{vnicIndex} provided by NSX Manager. -Read only.
- - enable_proxy_arp (
boolorNone) – Value is true if proxy arp is enabled. Enable proxy ARP if you want +-
+
- Parameters +
-
+
sub_interfaces (
SubInterfacesorNone) – List of sub interfaces. Sub interfaces can be created only on a +trunk interface.
+address_groups (
EdgeVnicAddressGroupsorNone) – Address group configuration of the interface.
+is_connected (
boolorNone) – Value is true if the vnic is connected to a logical switch, +standard portgroup or distributed portgroup.
+enable_send_redirects (
boolorNone) – Value is true if send redirects is enabled. Enable ICMP redirect to +convey routing information to hosts.
+in_shaping_policy (
TrafficShapingPolicyorNone) –
+label (
strorNone) – Interface label of format vNic_{vnicIndex} provided by NSX Manager. +Read only.
+enable_proxy_arp (
boolorNone) – Value is true if proxy arp is enabled. Enable proxy ARP if you want to allow the NSX Edge of type ‘gatewayServices’ to answer ARP -requests intended for other machines.
-- index (
long) – Index of the vnic. Min value is 0 and max value is 9. format: int32
- - name (
strorNone) – Name of the interface. Optional.
- - mtu (
longorNone) – MTU of the interface, with default as 1500. Min is 68, Max is 9000. -Optional. format: int32
- - fence_parameters (
listofKeyValueAttributesorNone) –
- - mac_addresses (
listofMacAddressorNone) – Distinct MAC addresses configured for the vnic. Optional.
- - out_shaping_policy (
TrafficShapingPolicyorNone) –
- - portgroup_name (
strorNone) – Name of the port group or logical switch.
- - enable_bridge_mode (
boolorNone) – Value is true if bridge mode is enabled.
- - type (
strorNone) – Type of the vnic. Values are uplink, internal, trunk. At least one -internal interface must be configured for NSX Edge HA to work.
- - portgroup_id (
strorNone) – Value are port group ID (standard portgroup or distributed +requests intended for other machines.
+ index (
long) – Index of the vnic. Min value is 0 and max value is 9. format: int32
+name (
strorNone) – Name of the interface. Optional.
+mtu (
longorNone) – MTU of the interface, with default as 1500. Min is 68, Max is 9000. +Optional. format: int32
+fence_parameters (
listofKeyValueAttributesorNone) –
+mac_addresses (
listofMacAddressorNone) – Distinct MAC addresses configured for the vnic. Optional.
+out_shaping_policy (
TrafficShapingPolicyorNone) –
+portgroup_name (
strorNone) – Name of the port group or logical switch.
+enable_bridge_mode (
boolorNone) – Value is true if bridge mode is enabled.
+type (
strorNone) – Type of the vnic. Values are uplink, internal, trunk. At least one +internal interface must be configured for NSX Edge HA to work.
+portgroup_id (
strorNone) – Value are port group ID (standard portgroup or distributed portgroup) or virtual wire ID (logical switch). Logical switch cannot be used for a TRUNK vnic. Portgroup cannot be shared among vnics/LIFs. Required when isConnected is specified as true. Example ‘network-17’ (standard portgroup), ‘dvportgroup-34’ (distributed -portgroup) or ‘virtualwire-2’ (logical switch).
+portgroup) or ‘virtualwire-2’ (logical switch).
+- sub_interfaces (
com.vmware.vmc.model_client.Vnic(sub_interfaces=None, address_groups=None, is_connected=None, enable_send_redirects=None, in_shaping_policy=None, label=None, enable_proxy_arp=None, index=None, name=None, mtu=None, fence_parameters=None, mac_addresses=None, out_shaping_policy=None, portgroup_name=None, enable_bridge_mode=None, type=None, portgroup_id=None)¶
-
-class
com.vmware.vmc.model_client.Vnics(vnics=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructOrdered list of NSX Edge vnics. Until one connected vnic is configured, none of the configured features will serve the network.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: vnics ( -listofVnicorNone) – Ordered list of NSX Edge vnics.-
+
- Parameters +
vnics (
+listofVnicorNone) – Ordered list of NSX Edge vnics.
+
com.vmware.vmc.model_client.Vnics(vnics=None)¶
-
-class
com.vmware.vmc.model_client.VpcInfo(vpc_cidr=None, vm_security_group_id=None, route_table_id=None, edge_subnet_id=None, id=None, api_association_id=None, private_subnet_id=None, api_subnet_id=None, esx_security_group_id=None, subnet_id=None, internet_gateway_id=None, security_group_id=None, association_id=None, vgw_route_table_id=None, edge_association_id=None, vif_ids=None, peering_connection_id=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- vpc_cidr (
strorNone) –
- - vm_security_group_id (
strorNone) –
- - route_table_id (
strorNone) –
- - edge_subnet_id (
strorNone) – Id of the NSX edge associated with this VPC
- - id (
strorNone) –
- - api_association_id (
strorNone) – Id of the association between subnet and route-table
- - private_subnet_id (
strorNone) –
- - api_subnet_id (
strorNone) – Id associated with this VPC
- - esx_security_group_id (
strorNone) –
- - subnet_id (
strorNone) –
- - internet_gateway_id (
strorNone) –
- - security_group_id (
strorNone) –
- - association_id (
strorNone) –
- - vgw_route_table_id (
strorNone) – Route table which contains the route to VGW
- - edge_association_id (
strorNone) – Id of the association between edge subnet and route-table
- - vif_ids (
listofstrorNone) –
- - peering_connection_id (
strorNone) –
+ - Parameters +
-
+
vpc_cidr (
strorNone) –
+vm_security_group_id (
strorNone) –
+route_table_id (
strorNone) –
+edge_subnet_id (
strorNone) – Id of the NSX edge associated with this VPC
+id (
strorNone) –
+api_association_id (
strorNone) – Id of the association between subnet and route-table
+private_subnet_id (
strorNone) –
+api_subnet_id (
strorNone) – Id associated with this VPC
+esx_security_group_id (
strorNone) –
+subnet_id (
strorNone) –
+internet_gateway_id (
strorNone) –
+security_group_id (
strorNone) –
+association_id (
strorNone) –
+vgw_route_table_id (
strorNone) – Route table which contains the route to VGW
+edge_association_id (
strorNone) – Id of the association between edge subnet and route-table
+vif_ids (
listofstrorNone) –
+peering_connection_id (
strorNone) –
-
+
+- vpc_cidr (
com.vmware.vmc.model_client.VpcInfo(vpc_cidr=None, vm_security_group_id=None, route_table_id=None, edge_subnet_id=None, id=None, api_association_id=None, private_subnet_id=None, api_subnet_id=None, esx_security_group_id=None, subnet_id=None, internet_gateway_id=None, security_group_id=None, association_id=None, vgw_route_table_id=None, edge_association_id=None, vif_ids=None, peering_connection_id=None)¶
-
-class
com.vmware.vmc.model_client.VpcInfoSubnets(vpc_id=None, cidr_block=None, description=None, subnets=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- vpc_id (
strorNone) – The ID of the VPC these subnets belong to.
- - cidr_block (
strorNone) – The overall CIDR block of the VPC. This is the AWS primary CIDR -block.
- - description (
strorNone) – The description of the VPC; usually it’s name or id.
- - subnets (
listofSubnetInfoorNone) –
+ - Parameters +
-
+
vpc_id (
strorNone) – The ID of the VPC these subnets belong to.
+cidr_block (
strorNone) – The overall CIDR block of the VPC. This is the AWS primary CIDR +block.
+description (
strorNone) – The description of the VPC; usually it’s name or id.
+subnets (
listofSubnetInfoorNone) –
-
+
+- vpc_id (
com.vmware.vmc.model_client.VpcInfoSubnets(vpc_id=None, cidr_block=None, description=None, subnets=None)¶
-
-class
com.vmware.vmc.model_client.Vpn(version=None, on_prem_gateway_ip=None, on_prem_network_cidr=None, pfs_enabled=None, id=None, channel_status=None, on_prem_nat_ip=None, name=None, internal_network_ids=None, tunnel_statuses=None, encryption=None, enabled=None, state=None, dh_group=None, authentication=None, pre_shared_key=None, ike_option=None, digest_algorithm=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- version (
strorNone) –
- - on_prem_gateway_ip (
strorNone) –
- - on_prem_network_cidr (
strorNone) –
- - pfs_enabled (
boolorNone) –
- - id (
strorNone) –
- - channel_status (
VpnChannelStatusorNone) –
- - on_prem_nat_ip (
strorNone) –
- - name (
strorNone) –
- - internal_network_ids (
listofstrorNone) –
- - tunnel_statuses (
listofVpnTunnelStatusorNone) –
- - encryption (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
version (
strorNone) –
+on_prem_gateway_ip (
strorNone) –
+on_prem_network_cidr (
strorNone) –
+pfs_enabled (
boolorNone) –
+id (
strorNone) –
+channel_status (
VpnChannelStatusorNone) –
+on_prem_nat_ip (
strorNone) –
+name (
strorNone) –
+internal_network_ids (
listofstrorNone) –
+tunnel_statuses (
listofVpnTunnelStatusorNone) –
+encryption (
strorNone) –Possible values are:
-
-- enabled (
boolorNone) –
- - state (
strorNone) –Possible values are:
+
+ enabled (
boolorNone) –
+state (
strorNone) –Possible values are:
-
-- dh_group (
strorNone) –Possible values are:
+
+ dh_group (
strorNone) –Possible values are:
-
-- authentication (
strorNone) –Possible values are:
+
+ authentication (
strorNone) –Possible values are:
-
-- pre_shared_key (
strorNone) –
- - ike_option (
strorNone) –Possible values are:
+
+ pre_shared_key (
strorNone) –
+ike_option (
strorNone) –Possible values are:
-
-- digest_algorithm (
strorNone) –Possible values are:
+
+ digest_algorithm (
strorNone) –Possible values are:
-
+
+- version (
com.vmware.vmc.model_client.Vpn(version=None, on_prem_gateway_ip=None, on_prem_network_cidr=None, pfs_enabled=None, id=None, channel_status=None, on_prem_nat_ip=None, name=None, internal_network_ids=None, tunnel_statuses=None, encryption=None, enabled=None, state=None, dh_group=None, authentication=None, pre_shared_key=None, ike_option=None, digest_algorithm=None)¶
-
-
STATE_PARTIALLY_CONNECTED= 'PARTIALLY_CONNECTED'¶
+
STATE_PARTIALLY_CONNECTED = 'PARTIALLY_CONNECTED'¶
-
-class
com.vmware.vmc.model_client.VpnChannelStatus(channel_status=None, channel_state=None, last_info_message=None, failure_message=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- channel_status (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
channel_status (
strorNone) –Possible values are:
-
-- channel_state (
strorNone) –
- - last_info_message (
strorNone) –
- - failure_message (
strorNone) –
+
+ channel_state (
strorNone) –
+last_info_message (
strorNone) –
+failure_message (
strorNone) –
+- channel_status (
com.vmware.vmc.model_client.VpnChannelStatus(channel_status=None, channel_state=None, last_info_message=None, failure_message=None)¶
-
-class
com.vmware.vmc.model_client.VpnTunnelStatus(on_prem_subnet=None, traffic_stats=None, last_info_message=None, local_subnet=None, tunnel_state=None, failure_message=None, tunnel_status=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- on_prem_subnet (
strorNone) –
- - traffic_stats (
VpnTunnelTrafficStatsorNone) –
- - last_info_message (
strorNone) –
- - local_subnet (
strorNone) –
- - tunnel_state (
strorNone) –
- - failure_message (
strorNone) –
- - tunnel_status (
strorNone) –Possible values are:
+-
+
- Parameters +
-
+
on_prem_subnet (
strorNone) –
+traffic_stats (
VpnTunnelTrafficStatsorNone) –
+last_info_message (
strorNone) –
+local_subnet (
strorNone) –
+tunnel_state (
strorNone) –
+failure_message (
strorNone) –
+tunnel_status (
strorNone) –Possible values are:
-
+
+- on_prem_subnet (
com.vmware.vmc.model_client.VpnTunnelStatus(on_prem_subnet=None, traffic_stats=None, last_info_message=None, local_subnet=None, tunnel_state=None, failure_message=None, tunnel_status=None)¶
-
-class
com.vmware.vmc.model_client.VpnTunnelTrafficStats(packets_out=None, packet_received_errors=None, rx_bytes_on_local_subnet=None, replay_errors=None, sequence_number_over_flow_errors=None, encryption_failures=None, integrity_errors=None, packet_sent_errors=None, decryption_failures=None, packets_in=None, tx_bytes_from_local_subnet=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- packets_out (
strorNone) –
- - packet_received_errors (
strorNone) –
- - rx_bytes_on_local_subnet (
strorNone) –
- - replay_errors (
strorNone) –
- - sequence_number_over_flow_errors (
strorNone) –
- - encryption_failures (
strorNone) –
- - integrity_errors (
strorNone) –
- - packet_sent_errors (
strorNone) –
- - decryption_failures (
strorNone) –
- - packets_in (
strorNone) –
- - tx_bytes_from_local_subnet (
strorNone) –
+ - Parameters +
-
+
packets_out (
strorNone) –
+packet_received_errors (
strorNone) –
+rx_bytes_on_local_subnet (
strorNone) –
+replay_errors (
strorNone) –
+sequence_number_over_flow_errors (
strorNone) –
+encryption_failures (
strorNone) –
+integrity_errors (
strorNone) –
+packet_sent_errors (
strorNone) –
+decryption_failures (
strorNone) –
+packets_in (
strorNone) –
+tx_bytes_from_local_subnet (
strorNone) –
-
+
+- packets_out (
com.vmware.vmc.model_client.VpnTunnelTrafficStats(packets_out=None, packet_received_errors=None, rx_bytes_on_local_subnet=None, replay_errors=None, sequence_number_over_flow_errors=None, encryption_failures=None, integrity_errors=None, packet_sent_errors=None, decryption_failures=None, packets_in=None, tx_bytes_from_local_subnet=None)¶
-
-class
com.vmware.vmc.model_client.VsanConfigConstraints(max_capacity=None, recommended_capacities=None, supported_capacity_increment=None, min_capacity=None, num_hosts=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStructThis describes the possible physical storage capacity choices for use with a given VsanStorageDesigner implementation. These choices are specific to a customer-defined number of hosts per cluster.
--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- max_capacity (
long) – Maximum capacity supported for cluster (GiB). format: int64
- - recommended_capacities (
listoflong) – List of supported capacities which may offer preferable performance -(GiB). format: int64
- - supported_capacity_increment (
longorNone) – Increment to be added to min_capacity to result in a supported -capacity (GiB). format: int64
- - min_capacity (
long) – Minimum capacity supported for cluster (GiB). format: int64
- - num_hosts (
long) – Number of hosts in cluster. format: int64
+ - Parameters +
-
+
max_capacity (
long) – Maximum capacity supported for cluster (GiB). format: int64
+recommended_capacities (
listoflong) – List of supported capacities which may offer preferable performance +(GiB). format: int64
+supported_capacity_increment (
longorNone) – Increment to be added to min_capacity to result in a supported +capacity (GiB). format: int64
+min_capacity (
long) – Minimum capacity supported for cluster (GiB). format: int64
+num_hosts (
long) – Number of hosts in cluster. format: int64
-
+
+- max_capacity (
com.vmware.vmc.model_client.VsanConfigConstraints(max_capacity=None, recommended_capacities=None, supported_capacity_increment=None, min_capacity=None, num_hosts=None)¶
-
-class
com.vmware.vmc.model_client.VsanEncryptionConfig(port=None, certificate=None)¶
+class Bases:
vmware.vapi.bindings.struct.VapiStruct--Tip
-The arguments are used to initialize data attributes with the same +
Tip
+The arguments are used to initialize data attributes with the same names.
-
+- - - Parameters: -
-
- port (
longorNone) – Port to connect to AWS Key Management Service
- - certificate (
strorNone) – Public certificate used to connect to AWS Key Management Service
+ - Parameters +
-
+
port (
longorNone) – Port to connect to AWS Key Management Service
+certificate (
strorNone) – Public certificate used to connect to AWS Key Management Service
-
+
+- port (
com.vmware.vmc.model_client.VsanEncryptionConfig(port=None, certificate=None)¶
com.vmware.vmc.orgs_client module¶
-
-class
com.vmware.vmc.orgs_client.AccountLink(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org)¶
+ Gets a link that can be used on a customer’s account to start the linking process.
--
+- - - Parameters: org ( -str) – Organization identifier. (required)Raise: com.vmware.vapi.std.errors_client.Error-Generic Error-
+
- Parameters +
org (
+str) – Organization identifier. (required)
+- Raise +
+com.vmware.vapi.std.errors_client.Error+Generic Error
+
get(org)¶
com.vmware.vmc.orgs_client.AccountLink(config)¶
-
-class
com.vmware.vmc.orgs_client.Providers(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
list(org)¶
- -
+- - - Parameters: org ( -str) – Organization identifier. (required)Return type: listofcom.vmware.vmc.model_client.AwsCloudProviderReturns: - Raise: com.vmware.vapi.std.errors_client.Unauthenticated-UnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized-ForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound-Organization doesn’t existlist(org)¶ +-
+
- Parameters +
org (
+str) – Organization identifier. (required)
+- Return type +
- + +
- Returns +
- + +
- Raise +
+com.vmware.vapi.std.errors_client.Unauthenticated+Unauthorized
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthorized+Forbidden
+- Raise +
+com.vmware.vapi.std.errors_client.NotFound+Organization doesn’t exist
+
com.vmware.vmc.orgs_client.Providers(config)¶
-
-class
com.vmware.vmc.orgs_client.Reservations(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
list(org)¶
+ Get all reservations for this org
--
+- - - Parameters: org ( -str) – Organization identifier. (required)Return type: listofcom.vmware.vmc.model_client.MaintenanceWindowEntryReturns: - Raise: com.vmware.vapi.std.errors_client.Unauthenticated-UnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized-Access not allowed to the operation for the current user-
+
- Parameters +
org (
+str) – Organization identifier. (required)
+- Return type +
- + +
- Returns +
- + +
- Raise +
+com.vmware.vapi.std.errors_client.Unauthenticated+Unauthorized
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthorized+Access not allowed to the operation for the current user
+
list(org)¶
com.vmware.vmc.orgs_client.Reservations(config)¶
-
-class
com.vmware.vmc.orgs_client.SddcTemplates(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
delete(org, template_id)¶
+ Delete SDDC template identified by given id.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - template_id (
str) – SDDC Template identifier (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+template_id (
str) – SDDC Template identifier (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
delete(org, template_id)¶
com.vmware.vmc.orgs_client.SddcTemplates(config)¶
-
-
get(org, template_id)¶
+ Get configuration template by given template id.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - template_id (
str) – SDDC Template identifier (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+template_id (
str) – SDDC Template identifier (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.SddcTemplate
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.SddcTemplate
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the SDDC Template with given identifier
+- org (
get(org, template_id)¶
-
-
list(org)¶
+ List all available SDDC configuration templates in an organization
--
+- - - Parameters: org ( -str) – Organization identifier. (required)Return type: listofcom.vmware.vmc.model_client.SddcTemplateReturns: - Raise: com.vmware.vapi.std.errors_client.Unauthenticated-UnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized-Forbidden-
+
- Parameters +
org (
+str) – Organization identifier. (required)
+- Return type +
- + +
- Returns +
- + +
- Raise +
+com.vmware.vapi.std.errors_client.Unauthenticated+Unauthorized
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthorized+Forbidden
+
list(org)¶
-
-class
com.vmware.vmc.orgs_client.Sddcs(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
create(org, sddc_config)¶
+ Provision an SDDC in target cloud
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc_config (
com.vmware.vmc.model_client.AwsSddcConfig) – sddcConfig (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc_config (
com.vmware.vmc.model_client.AwsSddcConfig) – sddcConfig (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
create(org, sddc_config)¶
com.vmware.vmc.orgs_client.Sddcs(config)¶
-
-
delete(org, sddc, retain_configuration=None, template_name=None, force=None)¶
+ Delete SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - retain_configuration (
boolorNone) – If = ‘true’, the SDDC’s configuration is retained as a template for +-
+
- Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+retain_configuration (
boolorNone) – If = ‘true’, the SDDC’s configuration is retained as a template for later use. This flag is applicable only to SDDCs in ACTIVE state. -(optional)
-- template_name (
strorNone) – Only applicable when retainConfiguration is also set to ‘true’. +(optional)
+ template_name (
strorNone) – Only applicable when retainConfiguration is also set to ‘true’. When set, this value will be used as the name of the SDDC -configuration template generated. (optional)
-- force (
strorNone) – If = ‘true’, will delete forcefully. Beware: do not use the force +configuration template generated. (optional)
+ force (
strorNone) – If = ‘true’, will delete forcefully. Beware: do not use the force flag if there is a chance an active provisioning or deleting task -is running against this SDDC. This option is restricted. (optional)
+is running against this SDDC. This option is restricted. (optional)
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for deletionRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedAccess not allowed to the operation for the current userRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the SDDC with given identifier
+- org (
delete(org, sddc, retain_configuration=None, template_name=None, force=None)¶
-
-
get(org, sddc)¶
+ Get SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Sddc
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Sddc
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the SDDC with given identifier
+- org (
get(org, sddc)¶
-
-
list(org)¶
+ List all the SDDCs of an organization
--
+- - - Parameters: org ( -str) – Organization identifier. (required)Return type: listofcom.vmware.vmc.model_client.SddcReturns: - Raise: com.vmware.vapi.std.errors_client.Unauthenticated-UnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized-Forbidden-
+
- Parameters +
org (
+str) – Organization identifier. (required)
+- Return type +
- + +
- Returns +
- + +
- Raise +
+com.vmware.vapi.std.errors_client.Unauthenticated+Unauthorized
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthorized+Forbidden
+
list(org)¶
-
-
patch(org, sddc, sddc_patch_request)¶
+ Patch SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - sddc_patch_request (
com.vmware.vmc.model_client.SddcPatchRequest) – Patch request for the SDDC (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+sddc_patch_request (
com.vmware.vmc.model_client.SddcPatchRequest) – Patch request for the SDDC (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Sddc
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Sddc
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestSDDC cannot be patchedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the SDDC with given identifier
+- org (
patch(org, sddc, sddc_patch_request)¶
-
-class
com.vmware.vmc.orgs_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs_client.StubFactory(stub_config)¶
-
-class
com.vmware.vmc.orgs_client.Subscriptions(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
GET_0_OFFER_TYPE_ON_DEMAND= 'ON_DEMAND'¶
+ Possible value for
offerTypeof methodSubscriptions.get_0().
GET_0_OFFER_TYPE_ON_DEMAND= 'ON_DEMAND'¶-
-
GET_0_OFFER_TYPE_TERM= 'TERM'¶
+ Possible value for
offerTypeof methodSubscriptions.get_0().
GET_0_OFFER_TYPE_TERM= 'TERM'¶-
-
create(org, subscription_request)¶
+ Initiates the creation of a subscription
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - subscription_request (
com.vmware.vmc.model_client.SubscriptionRequest) – subscriptionRequest (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+subscription_request (
com.vmware.vmc.model_client.SubscriptionRequest) – subscriptionRequest (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.InternalServerError+ +- Raise
+
-com.vmware.vapi.std.errors_client.InternalServerErrorServer error. Check retryable flag to see if request should be retried.
+- org (
create(org, subscription_request)¶
com.vmware.vmc.orgs_client.Subscriptions(config)¶
-
-
get(org, subscription)¶
+ Get subscription details for a given subscription id
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - subscription (
str) – SubscriptionId for an sddc. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+subscription (
str) – SubscriptionId for an sddc. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.SubscriptionDetails
-Raise: com.vmware.vapi.std.errors_client.InternalServerError+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.SubscriptionDetails
+- Raise
+
-com.vmware.vapi.std.errors_client.InternalServerErrorServer error. Check retryable flag to see if request should be retried.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot Found
+- org (
get(org, subscription)¶
-
-
get_0(org, offer_type=None)¶
+ Returns all subscriptions for a given org id
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - offer_type (
strorNone) – Offer Type * `ON_DEMAND` - on-demand subscription * +-
+
- Parameters +
-
+
org (
str) – Organization identifier. (required)
+offer_type (
strorNone) – Offer Type * `ON_DEMAND` - on-demand subscription * `TERM` - term subscription * All subscriptions if not -specified (optional)
+specified (optional)
Return type: - -Returns: - -Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+- +
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InternalServerError+ +- Raise
+
-com.vmware.vapi.std.errors_client.InternalServerErrorServer error. Check retryable flag to see if request should be retried.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot Found
+- org (
get_0(org, offer_type=None)¶
-
-class
com.vmware.vmc.orgs_client.Tasks(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, task)¶
+ Retrieve details of a task.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - task (
str) – Task identifier (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+task (
str) – Task identifier (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the task with given identifier
+- org (
get(org, task)¶
com.vmware.vmc.orgs_client.Tasks(config)¶
-
-
list(org, filter=None)¶
+ List all tasks with optional filtering.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - filter (
strorNone) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, +-
+
- Parameters +
-
+
org (
str) – Organization identifier. (required)
+filter (
strorNone) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’, ‘ge’, ‘mul’, ‘div’, ‘mod’, ‘sub’, ‘add’ Unary Operators: ‘not’, ‘-‘ (minus) String Operators: ‘startswith’, ‘endswith’, ‘length’, ‘contains’, ‘tolower’, ‘toupper’, Nested attributes are composed @@ -7566,70 +6790,64 @@ literal ‘created’ will be mapped to the time the resource was first created. Examples: - $filter=(updated gt 2016-08-09T13:00:00Z) and (org_id eq 278710ff4e-6b6d-4d4e-aefb-ca637f38609e) - $filter=(created eq 2016-08-09) - $filter=(created gt 2016-08-09) -and (sddc.status eq ‘READY’) (optional)
+and (sddc.status eq ‘READY’) (optional)
Return type: - -Returns: - -Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+- +
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
list(org, filter=None)¶
-
-
update(org, task, action=None)¶
+ Request that a running task be canceled. This is advisory only, some tasks may not be cancelable, and some tasks might take an arbitrary amount of time to respond to a cancelation request. The task must be monitored to determine subsequent status.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - task (
str) – Task identifier (required)
- - action (
strorNone) – If = ‘cancel’, task will be canceled (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+task (
str) – Task identifier (required)
+action (
strorNone) – If = ‘cancel’, task will be canceled (optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestInvalid action or bad argumentRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the task with given identifier
+- org (
update(org, task, action=None)¶
com.vmware.vmc.orgs.account_link_client module¶
-
-class
com.vmware.vmc.orgs.account_link_client.CompatibleSubnets(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, linked_account_id=None, region=None, sddc=None, force_refresh=None, instance_type=None)¶
+ Gets a customer’s compatible subnets for account linking
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - linked_account_id (
strorNone) – The linked connected account identifier (optional)
- - region (
strorNone) – The region of the cloud resources to work in (optional)
- - sddc (
strorNone) – sddc (optional)
- - force_refresh (
boolorNone) – When true, forces the mappings for datacenters to be refreshed for -the connected account. (optional)
- - instance_type (
strorNone) – The server instance type to be used. (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+linked_account_id (
strorNone) – The linked connected account identifier (optional)
+region (
strorNone) – The region of the cloud resources to work in (optional)
+sddc (
strorNone) – sddc (optional)
+force_refresh (
boolorNone) – When true, forces the mappings for datacenters to be refreshed for +the connected account. (optional)
+instance_type (
strorNone) – The server instance type to be used. (optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.AwsCompatibleSubnets
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.AwsCompatibleSubnets
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
get(org, linked_account_id=None, region=None, sddc=None, force_refresh=None, instance_type=None)¶
com.vmware.vmc.orgs.account_link_client.CompatibleSubnets(config)¶
-
-
post(org)¶
+ Sets which subnet to use to link accounts and finishes the linking process
--
+- - - Parameters: org ( -str) – Organization identifier. (required)Return type: com.vmware.vmc.model_client.AwsSubnetReturns: com.vmware.vmc.model.AwsSubnet -Raise: com.vmware.vapi.std.errors_client.Unauthenticated-UnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized-Forbidden-
+
- Parameters +
org (
+str) – Organization identifier. (required)
+- Return type +
- + +
- Returns +
com.vmware.vmc.model.AwsSubnet
+
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthenticated+Unauthorized
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthorized+Forbidden
+
post(org)¶
-
-class
com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, linked_account_id=None, region=None, sddc=None, instance_type=None)¶
+ Gets a customer’s compatible subnets for account linking via a task. The information is returned as a member of the task (found in task.params[‘subnet_list_result’] when you are notified it is complete), and it’s documented under ref /definitions/AwsCompatibleSubnets
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - linked_account_id (
strorNone) – The linked connected account identifier (optional)
- - region (
strorNone) – The region of the cloud resources to work in (optional)
- - sddc (
strorNone) – sddc (optional)
- - instance_type (
strorNone) – The server instance type to be used. (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+linked_account_id (
strorNone) – The linked connected account identifier (optional)
+region (
strorNone) – The region of the cloud resources to work in (optional)
+sddc (
strorNone) – sddc (optional)
+instance_type (
strorNone) – The server instance type to be used. (optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
get(org, linked_account_id=None, region=None, sddc=None, instance_type=None)¶
com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync(config)¶
-
-
post(aws_subnet, org)¶
+ Sets which subnet to use to link accounts and finishes the linking process via a task
--
+- - - Parameters: -
-
- aws_subnet (
com.vmware.vmc.model_client.AwsSubnet) – The subnet chosen by the customer (required)
- - org (
str) – Organization identifier. (required)
+ - Parameters +
-
+
aws_subnet (
com.vmware.vmc.model_client.AwsSubnet) – The subnet chosen by the customer (required)
+org (
str) – Organization identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- aws_subnet (
post(aws_subnet, org)¶
-
-class
com.vmware.vmc.orgs.account_link_client.ConnectedAccounts(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
delete(org, linked_account_path_id, force_even_when_sddc_present=None)¶
+ Delete a particular connected (linked) account.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - linked_account_path_id (
str) – The linked connected account identifier (required)
- - force_even_when_sddc_present (
boolorNone) – When true, forcibly removes a connected account even when SDDC’s -are still linked to it. (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+linked_account_path_id (
str) – The linked connected account identifier (required)
+force_even_when_sddc_present (
boolorNone) – When true, forcibly removes a connected account even when SDDC’s +are still linked to it. (optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.AwsCustomerConnectedAccount
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.AwsCustomerConnectedAccount
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestAn invalid connected account ID was specified, or the connection still has SDDCs active on it.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
delete(org, linked_account_path_id, force_even_when_sddc_present=None)¶
com.vmware.vmc.orgs.account_link_client.ConnectedAccounts(config)¶
-
-
get(org, provider=None)¶
+ Get a list of connected accounts
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - provider (
strorNone) – The cloud provider of the SDDC (AWS or ZeroCloud). Default value is -AWS. (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+provider (
strorNone) – The cloud provider of the SDDC (AWS or ZeroCloud). Default value is +AWS. (optional)
-
+
Return type:
-listofcom.vmware.vmc.model_client.AwsCustomerConnectedAccountReturns: - -Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+
+listofcom.vmware.vmc.model_client.AwsCustomerConnectedAccount- Returns
+- +
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
get(org, provider=None)¶
-
-class
com.vmware.vmc.orgs.account_link_client.MapCustomerZones(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
post(org, map_zones_request)¶
+ Creates a task to re-map customer’s datacenters across zones.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - map_zones_request (
com.vmware.vmc.model_client.MapZonesRequest) – The zones request information about who to map and what to map. -(required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+map_zones_request (
com.vmware.vmc.model_client.MapZonesRequest) – The zones request information about who to map and what to map. +(required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
post(org, map_zones_request)¶
com.vmware.vmc.orgs.account_link_client.MapCustomerZones(config)¶
-
-class
com.vmware.vmc.orgs.account_link_client.SddcConnections(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc=None)¶
+ Get a list of SDDC connections currently setup for the customer’s organization.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
strorNone) – sddc (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
strorNone) – sddc (optional)
-
+
Return type: - -Returns: - -Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+- +
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
get(org, sddc=None)¶
com.vmware.vmc.orgs.account_link_client.SddcConnections(config)¶
-
-class
com.vmware.vmc.orgs.account_link_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.account_link_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.reservations_client module¶
-
-class
com.vmware.vmc.orgs.reservations_client.Mw(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, reservation)¶
+ get the maintenance window for this SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - reservation (
str) – Reservation Identifier (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+reservation (
str) – Reservation Identifier (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.MaintenanceWindowGet
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.MaintenanceWindowGet
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedAccess not allowed to the operation for the current user
+- org (
get(org, reservation)¶
com.vmware.vmc.orgs.reservations_client.Mw(config)¶
-
-
put(org, reservation, window)¶
+ update the maintenance window for this SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - reservation (
str) – Reservation Identifier (required)
- - window (
com.vmware.vmc.model_client.MaintenanceWindow) – Maintenance Window (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+reservation (
str) – Reservation Identifier (required)
+window (
com.vmware.vmc.model_client.MaintenanceWindow) – Maintenance Window (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.MaintenanceWindow
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.MaintenanceWindow
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.ConcurrentChange+ +- Raise
+
-com.vmware.vapi.std.errors_client.ConcurrentChangeConflict with exiting reservationRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe reservation is not in a state that’s valid for updatesRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedAccess not allowed to the operation for the current user
+- org (
put(org, reservation, window)¶
-
-class
com.vmware.vmc.orgs.reservations_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.reservations_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs_client module¶
-
-class
com.vmware.vmc.orgs.sddcs_client.Clusters(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
create(org, sddc, cluster_config)¶
+ Creates a new cluster in customers sddcs with passed clusterConfig.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - cluster_config (
com.vmware.vmc.model_client.ClusterConfig) – clusterConfig (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+cluster_config (
com.vmware.vmc.model_client.ClusterConfig) – clusterConfig (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for updatesRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedAccess not allowed to the operation for the current userRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the cluster with the given identifier
+- org (
create(org, sddc, cluster_config)¶
com.vmware.vmc.orgs.sddcs_client.Clusters(config)¶
-
-
delete(org, sddc, cluster)¶
+ This is a force operation which will delete the cluster even if there can be a data loss. Before calling this operation, all the VMs should be powered off.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - cluster (
str) – cluster identifier (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+cluster (
str) – cluster identifier (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for updatesRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedAccess not allowed to the operation for the current userRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the cluster with the given id
+- org (
delete(org, sddc, cluster)¶
-
-class
com.vmware.vmc.orgs.sddcs_client.Convert(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
create(org, sddc)¶
+ This API converts a one host SDDC to a four node DEFAULT SDDC. It takes care of configuring and upgrading the vCenter configurations on the SDDC for high availability and data redundancy.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for updates, Method not allowedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedAccess not allowed to the operation for the current userRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the SDDC with given identifier
+- org (
create(org, sddc)¶
com.vmware.vmc.orgs.sddcs_client.Convert(config)¶
-
-class
com.vmware.vmc.orgs.sddcs_client.Esxs(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
create(org, sddc, esx_config, action=None)¶
+ Add/Remove one or more ESX hosts in the target cloud
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - esx_config (
com.vmware.vmc.model_client.EsxConfig) – esxConfig (required)
- - action (
strorNone) – If = ‘add’, will add the esx. If = ‘remove’, will delete the +-
+
- Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+esx_config (
com.vmware.vmc.model_client.EsxConfig) – esxConfig (required)
+action (
strorNone) – If = ‘add’, will add the esx. If = ‘remove’, will delete the esx/esxs bound to a single cluster (Cluster Id is mandatory for non cluster 1 esx remove). If = ‘force-remove’, will delete the esx even if it can lead to data loss (This is an privileged operation). @@ -895,218 +813,195 @@ an privileged operation). If = ‘removeFromAll’, will delete the esxs from all clusters in the SDDC (This is an privileged operation). If = ‘attach-diskgroup’, will attach the provided diskgroups to a given host (privileged). Default behaviour is ‘add’ -(optional)
+(optional)
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for updatesRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedAccess not allowed to the operation for the current userRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the SDDC with the given identifier
+- org (
create(org, sddc, esx_config, action=None)¶
com.vmware.vmc.orgs.sddcs_client.Esxs(config)¶
-
-class
com.vmware.vmc.orgs.sddcs_client.Publicips(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
create(org, sddc, spec)¶
+ Allocate public IPs for a SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - spec (
com.vmware.vmc.model_client.SddcAllocatePublicIpSpec) – allocation spec (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+spec (
com.vmware.vmc.model_client.SddcAllocatePublicIpSpec) – allocation spec (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for updatesRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedAccess not allowed to the operation for the current userRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the SDDC with given identifier
+- org (
create(org, sddc, spec)¶
com.vmware.vmc.orgs.sddcs_client.Publicips(config)¶
-
-
delete(org, sddc, id)¶
+ Free one public IP for a SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - id (
str) – ip allocation id (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+id (
str) – ip allocation id (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for updatesRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedAccess not allowed to the operation for the current userRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the public IP with given IP address
+- org (
delete(org, sddc, id)¶
-
-
get(org, sddc, id)¶
+ Get one public IP for a SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - id (
str) – ip allocation id (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+id (
str) – ip allocation id (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.SddcPublicIp
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.SddcPublicIp
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the public IP with given IP address
+- org (
get(org, sddc, id)¶
-
-
list(org, sddc)¶
+ list all public IPs for a SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
-
+
Return type: - -Returns: - -Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+- +
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the SDDC with given identifier
+- org (
list(org, sddc)¶
-
-
update(org, sddc, id, action, sddc_public_ip_object)¶
+ Attach or detach a public IP to workload VM for a SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - id (
str) – ip allocation id (required)
- - action (
str) – Type of action as ‘attach’, ‘detach’, ‘reattach’, or ‘rename’. For +-
+
- Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+id (
str) – ip allocation id (required)
+action (
str) – Type of action as ‘attach’, ‘detach’, ‘reattach’, or ‘rename’. For ‘attch’, the public IP must not be attached and ‘associated_private_ip’ in the payload needs to be set with a workload VM private IP. For ‘detach’, the public IP must be @@ -1114,107 +1009,95 @@ attached and ‘associated_private_ip’ in the payload should not be set with any value. For ‘reattach’, the public IP must be attached and ‘associated_private_ip’ in the payload needs to be set with a new workload VM private IP. For ‘rename’, the ‘name’ in the payload -needs to have a new name string. (required)
-- sddc_public_ip_object (
com.vmware.vmc.model_client.SddcPublicIp) – SddcPublicIp object to update (required)
+needs to have a new name string. (required)
+ sddc_public_ip_object (
com.vmware.vmc.model_client.SddcPublicIp) – SddcPublicIp object to update (required)
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for updatesRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedAccess not allowed to the operation for the current userRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the public IP with given IP address
+- org (
update(org, sddc, id, action, sddc_public_ip_object)¶
-
-class
com.vmware.vmc.orgs.sddcs_client.SddcTemplate(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc)¶
+ Get configuration template for an SDDC
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.SddcTemplate
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.SddcTemplate
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestSDDC is in a state that cannot be use for generating configuration templateRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundCannot find the SDDC with given identifier
+- org (
get(org, sddc)¶
com.vmware.vmc.orgs.sddcs_client.SddcTemplate(config)¶
-
-class
com.vmware.vmc.orgs.sddcs_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.storage_client module¶
-
-class
com.vmware.vmc.orgs.storage_client.ClusterConstraints(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, provider, num_hosts)¶
+ Get constraints on cluster storage size for EBS-backed clusters.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - provider (
str) – Cloud storage provider ID (example AWS) (required)
- - num_hosts (
long) – Number of hosts in cluster (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+provider (
str) – Cloud storage provider ID (example AWS) (required)
+num_hosts (
long) – Number of hosts in cluster (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.VsanConfigConstraints
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.VsanConfigConstraints
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestInvalid or missing parametersRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
get(org, provider, num_hosts)¶
com.vmware.vmc.orgs.storage_client.ClusterConstraints(config)¶
-
-class
com.vmware.vmc.orgs.storage_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.storage_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.subscriptions_client module¶
-
-class
com.vmware.vmc.orgs.subscriptions_client.OfferInstances(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
list(org, region, product_type, product=None, type=None)¶
+ List all offers available for the specific product type in the specific region
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - region (
str) – Region for the offer (required)
- - product_type (
str) – Type of the product in offers. *This has been deprecated*. Please -use product & type parameters (required)
- - product (
strorNone) – The product that you are trying to purchase, eg. host. This needs -to be accompanied by the type parameter (optional)
- - type (
strorNone) – The type/flavor of the product you are trying it purchase,eg. an +-
+
- Parameters +
-
+
org (
str) – Organization identifier. (required)
+region (
str) – Region for the offer (required)
+product_type (
str) – Type of the product in offers. *This has been deprecated*. Please +use product & type parameters (required)
+product (
strorNone) – The product that you are trying to purchase, eg. host. This needs +to be accompanied by the type parameter (optional)
+type (
strorNone) – The type/flavor of the product you are trying it purchase,eg. an `r5.metal` host. This needs to be accompanied by the -product parameter. (optional)
+product parameter. (optional)
Return type: - -Returns: com.vmware.vmc.model.OfferInstancesHolder
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.OfferInstancesHolder
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad Request. Type of the product not supported.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
list(org, region, product_type, product=None, type=None)¶
com.vmware.vmc.orgs.subscriptions_client.OfferInstances(config)¶
-
-class
com.vmware.vmc.orgs.subscriptions_client.Products(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
list(org)¶
+ List of all the products that are available for purchase.
--
+- - - Parameters: org ( -str) – Organization identifier. (required)Return type: listofcom.vmware.vmc.model_client.SubscriptionProductsReturns: - Raise: com.vmware.vapi.std.errors_client.Unauthenticated-UnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized-ForbiddenRaise: com.vmware.vapi.std.errors_client.InternalServerError-Internal server error-
+
- Parameters +
org (
+str) – Organization identifier. (required)
+- Return type +
- + +
- Returns +
- + +
- Raise +
+com.vmware.vapi.std.errors_client.Unauthenticated+Unauthorized
+- Raise +
+com.vmware.vapi.std.errors_client.Unauthorized+Forbidden
+- Raise +
+com.vmware.vapi.std.errors_client.InternalServerError+Internal server error
+
list(org)¶
com.vmware.vmc.orgs.subscriptions_client.Products(config)¶
-
-class
com.vmware.vmc.orgs.subscriptions_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.subscriptions_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.tbrs_client module¶
-
-class
com.vmware.vmc.orgs.tbrs_client.Reservation(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
post(org, sddc_state=None)¶
+ Retreive all reservations for all SDDCs in this org
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc_state (
com.vmware.vmc.model_client.SddcStateRequestorNone) – SDDCs and/or states to query (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc_state (
com.vmware.vmc.model_client.SddcStateRequestorNone) – SDDCs and/or states to query (optional)
-
+
Return type:
-dictofstrandlistofcom.vmware.vmc.model_client.ReservationWindowReturns: - -Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+
+dictofstrandlistofcom.vmware.vmc.model_client.ReservationWindow- Returns
+- +
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad CallRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
post(org, sddc_state=None)¶
com.vmware.vmc.orgs.tbrs_client.Reservation(config)¶
-
-class
com.vmware.vmc.orgs.tbrs_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.tbrs_client.StubFactory(stub_config)¶
-
-class
com.vmware.vmc.orgs.tbrs_client.SupportWindow(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, minimum_seats_available=None, created_by=None)¶
+ Get all available support windows
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - minimum_seats_available (
longorNone) – minimum seats available (used as a filter) (optional)
- - created_by (
strorNone) – user name which was used to create the support window (used as a -filter) (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+minimum_seats_available (
longorNone) – minimum seats available (used as a filter) (optional)
+created_by (
strorNone) – user name which was used to create the support window (used as a +filter) (optional)
-
+
Return type: - -Returns: - -Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+- +
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestInvalid requestRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNo support windows are available
+- org (
get(org, minimum_seats_available=None, created_by=None)¶
com.vmware.vmc.orgs.tbrs_client.SupportWindow(config)¶
-
-
put(org, id, sddc_id)¶
+ Move Sddc to new support window
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - id (
str) – Target Support Window ID (required)
- - sddc_id (
com.vmware.vmc.model_client.SddcId) – SDDC to move (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+id (
str) – Target Support Window ID (required)
+sddc_id (
com.vmware.vmc.model_client.SddcId) – SDDC to move (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.SupportWindowId
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.SupportWindowId
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestInvalid requestRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbiddenRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundFeature does not exist
+- org (
put(org, id, sddc_id)¶
com.vmware.vmc.orgs.sddcs.addons_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.addons_client.Credentials(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
CREATE_ADDON_TYPE_HCX= 'HCX'¶
+ Possible value for
addonTypeof methodCredentials.create().
CREATE_ADDON_TYPE_HCX= 'HCX'¶-
-
GET_ADDON_TYPE_HCX= 'HCX'¶
+ Possible value for
addonTypeof methodCredentials.get().
GET_ADDON_TYPE_HCX= 'HCX'¶-
-
LIST_ADDON_TYPE_HCX= 'HCX'¶
+ Possible value for
addonTypeof methodCredentials.list().
LIST_ADDON_TYPE_HCX= 'HCX'¶-
-
UPDATE_ADDON_TYPE_HCX= 'HCX'¶
+ Possible value for
addonTypeof methodCredentials.update().
UPDATE_ADDON_TYPE_HCX= 'HCX'¶-
-
create(org, sddc_id, addon_type, credentials)¶
+ Associated a new add on credentials with the SDDC such as HCX
--
+- - - Parameters: -
-
- org (
str) – Org id of the associated SDDC (required)
- - sddc_id (
str) – Id of the SDDC (required)
- - addon_type (
str) – Add on type (required)
- - credentials (
com.vmware.vmc.model_client.NewCredentials) – Credentials creation payload (required)
+ - Parameters +
-
+
org (
str) – Org id of the associated SDDC (required)
+sddc_id (
str) – Id of the SDDC (required)
+addon_type (
str) – Add on type (required)
+credentials (
com.vmware.vmc.model_client.NewCredentials) – Credentials creation payload (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.NewCredentials
-Raise: com.vmware.vapi.std.errors_client.ConcurrentChange+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.NewCredentials
+- Raise
+
-com.vmware.vapi.std.errors_client.ConcurrentChangeCredentials with same name exists with in the scope of addOnTypeRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestInvalid inputRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
create(org, sddc_id, addon_type, credentials)¶
com.vmware.vmc.orgs.sddcs.addons_client.Credentials(config)¶
-
-
get(org, sddc_id, addon_type, name)¶
+ Get credential details by name
--
+- - - Parameters: -
-
- org (
str) – Org id of the associated SDDC (required)
- - sddc_id (
str) – Id of the SDDC (required)
- - addon_type (
str) – Add on type (required)
- - name (
str) – name of the credentials (required)
+ - Parameters +
-
+
org (
str) – Org id of the associated SDDC (required)
+sddc_id (
str) – Id of the SDDC (required)
+addon_type (
str) – Add on type (required)
+name (
str) – name of the credentials (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.NewCredentials
-Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.NewCredentials
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
get(org, sddc_id, addon_type, name)¶
-
-
list(org, sddc_id, addon_type)¶
+ List all the credentials assoicated with an addon type with in a SDDC
--
+- - - Parameters: -
-
- org (
str) – Org id of the associated SDDC (required)
- - sddc_id (
str) – Id of the SDDC (required)
- - addon_type (
str) – Add on type (required)
+ - Parameters +
-
+
org (
str) – Org id of the associated SDDC (required)
+sddc_id (
str) – Id of the SDDC (required)
+addon_type (
str) – Add on type (required)
-
+
Return type: - -Returns: - -Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Return type
+- +
+- Returns
+- +
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
list(org, sddc_id, addon_type)¶
-
-
update(org, sddc_id, addon_type, name, credentials)¶
+ Update credential details
--
+- - - Parameters: -
-
- org (
str) – Org id of the associated SDDC (required)
- - sddc_id (
str) – Id of the SDDC (required)
- - addon_type (
str) – Add on type (required)
- - name (
str) – name of the credentials (required)
- - credentials (
com.vmware.vmc.model_client.UpdateCredentials) – Credentials update payload (required)
+ - Parameters +
-
+
org (
str) – Org id of the associated SDDC (required)
+sddc_id (
str) – Id of the SDDC (required)
+addon_type (
str) – Add on type (required)
+name (
str) – name of the credentials (required)
+credentials (
com.vmware.vmc.model_client.UpdateCredentials) – Credentials update payload (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.NewCredentials
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.NewCredentials
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad requestRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
update(org, sddc_id, addon_type, name, credentials)¶
-
-class
com.vmware.vmc.orgs.sddcs.addons_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.addons_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.dns_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.dns_client.Private(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
update(org, sddc)¶
+ Update the DNS records of management VMs to use private IP addresses
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for updates or invalid bodyRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
update(org, sddc)¶
com.vmware.vmc.orgs.sddcs.dns_client.Private(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.dns_client.Public(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
update(org, sddc)¶
+ Update the DNS records of management VMs to use public IP addresses
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for updates or invalid bodyRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
update(org, sddc)¶
com.vmware.vmc.orgs.sddcs.dns_client.Public(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.dns_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.dns_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.management_vms_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.management_vms_client.Dns(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
UPDATE_IP_TYPE_PRIVATE= 'private'¶
+ Possible value for
ipTypeof methodDns.update().
UPDATE_IP_TYPE_PRIVATE= 'private'¶-
-
UPDATE_IP_TYPE_PUBLIC= 'public'¶
+ Possible value for
ipTypeof methodDns.update().
UPDATE_IP_TYPE_PUBLIC= 'public'¶-
-
update(org, sddc, management_vm_id, ip_type)¶
+ Update the DNS records of management VMs to use public or private IP addresses
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - management_vm_id (
str) – the management VM ID (required)
- - ip_type (
str) – the ip type to associate with FQDN in DNS (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+management_vm_id (
str) – the management VM ID (required)
+ip_type (
str) – the ip type to associate with FQDN in DNS (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestThe sddc is not in a state that’s valid for updates or invalid bodyRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
update(org, sddc, management_vm_id, ip_type)¶
com.vmware.vmc.orgs.sddcs.management_vms_client.Dns(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.management_vms_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.management_vms_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networking_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc)¶
+ Retrieve metadata for connectivity tests.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.ConnectivityValidationGroups
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.ConnectivityValidationGroups
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
get(org, sddc)¶
com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests(config)¶
-
-
post(org, sddc, request_info, action)¶
+ ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’].
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - request_info (
com.vmware.vmc.model_client.ConnectivityValidationGroup) – request information (required)
- - action (
str) – If = ‘start’, start connectivity tests. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+request_info (
com.vmware.vmc.model_client.ConnectivityValidationGroup) – request information (required)
+action (
str) – If = ‘start’, start connectivity tests. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Task
-Raise: com.vmware.vapi.std.errors_client.Unauthenticated+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Task
+- Raise
+
-com.vmware.vapi.std.errors_client.UnauthenticatedUnauthorizedRaise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad RequestRaise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden
+- org (
post(org, sddc, request_info, action)¶
-
-class
com.vmware.vmc.orgs.sddcs.networking_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networking_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks_client.Edges(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_type, prev_edge_id=None, start_index=None, page_size=None, sort_order_ascending=None, sort_by=None, filter=None, ld_rname=None)¶
+ Retrieve information about all management and compute gateways and other routers (NSX Edges).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_type (
str) – Retrieve records matching NSX Edge type (‘gatewayServices’ or +-
+
- Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_type (
str) – Retrieve records matching NSX Edge type (‘gatewayServices’ or ‘distributedRouter’). Specify gatewayServices to find management -and compute gateways in your SDDC. (required)
-- prev_edge_id (
strorNone) – Provide Edge ID as prevEdgeId to serve as reference for startIndex. -(optional)
- - start_index (
longorNone) – Start index for the current page. Default is 0. (optional)
- - page_size (
longorNone) – Number of records per page. Default is 256. (optional)
- - sort_order_ascending (
boolorNone) – Set to true to fetch records in ascending sorted order. (optional)
- - sort_by (
strorNone) – Sort records using one of the column names (id, name, description, -tenantId, size, enableFips). (optional)
- - filter (
strorNone) – Filter records matching the NSX Edge ID, name or description. -(optional)
- - ld_rname (
strorNone) – (optional)
+and compute gateways in your SDDC. (required)
+ prev_edge_id (
strorNone) – Provide Edge ID as prevEdgeId to serve as reference for startIndex. +(optional)
+start_index (
longorNone) – Start index for the current page. Default is 0. (optional)
+page_size (
longorNone) – Number of records per page. Default is 256. (optional)
+sort_order_ascending (
boolorNone) – Set to true to fetch records in ascending sorted order. (optional)
+sort_by (
strorNone) – Sort records using one of the column names (id, name, description, +tenantId, size, enableFips). (optional)
+filter (
strorNone) – Filter records matching the NSX Edge ID, name or description. +(optional)
+ld_rname (
strorNone) – (optional)
Return type: - -Returns: com.vmware.vmc.model.PagedEdgeList
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.PagedEdgeList
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_type, prev_edge_id=None, start_index=None, page_size=None, sort_order_ascending=None, sort_by=None, filter=None, ld_rname=None)¶
com.vmware.vmc.orgs.sddcs.networks_client.Edges(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks_client.Logical(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
create(org, sddc, sddc_network)¶
+ Create a network in an SDDC.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - sddc_network (
com.vmware.vmc.model_client.SddcNetwork) – (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+sddc_network (
com.vmware.vmc.model_client.SddcNetwork) – (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
create(org, sddc, sddc_network)¶
com.vmware.vmc.orgs.sddcs.networks_client.Logical(config)¶
-
-
delete(org, sddc, network_id)¶
+ Delete a network in an SDDC.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - network_id (
str) – Logical Network Identifier (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+network_id (
str) – Logical Network Identifier (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
delete(org, sddc, network_id)¶
-
-
get(org, sddc, network_id)¶
+ Retrieve information about a network in an SDDC.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - network_id (
str) – Logical Network Identifier (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+network_id (
str) – Logical Network Identifier (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.SddcNetwork
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.SddcNetwork
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, network_id)¶
-
-
get_0(org, sddc, page_size=None, start_index=None, prev_sddc_network_id=None, sort_order_ascending=None)¶
+ Retrieve all networks in an SDDC.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - page_size (
longorNone) – Page size for pagination. (optional)
- - start_index (
longorNone) – Start index of page. (optional)
- - prev_sddc_network_id (
strorNone) – Previous logical network id. (optional)
- - sort_order_ascending (
boolorNone) – Sort order ascending. (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+page_size (
longorNone) – Page size for pagination. (optional)
+start_index (
longorNone) – Start index of page. (optional)
+prev_sddc_network_id (
strorNone) – Previous logical network id. (optional)
+sort_order_ascending (
boolorNone) – Sort order ascending. (optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.DataPageSddcNetwork
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.DataPageSddcNetwork
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get_0(org, sddc, page_size=None, start_index=None, prev_sddc_network_id=None, sort_order_ascending=None)¶
-
-
update(org, sddc, network_id, sddc_network)¶
+ Modify a network in an SDDC.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - network_id (
str) – Logical Network Identifier (required)
- - sddc_network (
com.vmware.vmc.model_client.SddcNetwork) – (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+network_id (
str) – Logical Network Identifier (required)
+sddc_network (
com.vmware.vmc.model_client.SddcNetwork) – (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
update(org, sddc, network_id, sddc_network)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
delete(org, sddc, edge_id)¶
+ Delete SDDC L2 VPN configuration.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Compute Gateway Edge Identifier (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Compute Gateway Edge Identifier (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
delete(org, sddc, edge_id)¶
com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config(config)¶
-
-
get(org, sddc, edge_id, show_sensitive_data=None)¶
+ Retrieve SDDC L2 VPN configuration.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Compute Gateway Edge Identifier (required)
- - show_sensitive_data (
boolorNone) – (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Compute Gateway Edge Identifier (required)
+show_sensitive_data (
boolorNone) – (optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.Nsxl2vpn
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Nsxl2vpn
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, show_sensitive_data=None)¶
-
-
update(org, sddc, edge_id, nsxl2vpn)¶
+ Modify SDDC L2 VPN configuration
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Compute Gateway Edge Identifier (required)
- - nsxl2vpn (
com.vmware.vmc.model_client.Nsxl2vpn) – (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Compute Gateway Edge Identifier (required)
+nsxl2vpn (
com.vmware.vmc.model_client.Nsxl2vpn) – (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
update(org, sddc, edge_id, nsxl2vpn)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
add(org, sddc, edge_id, firewall_rules)¶
+ Append firewall rules for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - firewall_rules (
com.vmware.vmc.model_client.FirewallRules) – (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+firewall_rules (
com.vmware.vmc.model_client.FirewallRules) – (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
add(org, sddc, edge_id, firewall_rules)¶
com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules(config)¶
-
-
delete(org, sddc, edge_id, rule_id)¶
+ Delete a specific firewall rule for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - rule_id (
long) – Rule Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+rule_id (
long) – Rule Identifier. (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
delete(org, sddc, edge_id, rule_id)¶
-
-
get(org, sddc, edge_id, rule_id)¶
+ Retrieve a specific firewall rule for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - rule_id (
long) – Rule Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+rule_id (
long) – Rule Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Nsxfirewallrule
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Nsxfirewallrule
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, rule_id)¶
-
-
update(org, sddc, edge_id, rule_id, nsxfirewallrule)¶
+ Modify the specified firewall rule for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - rule_id (
long) – Rule Identifier. (required)
- - nsxfirewallrule (
com.vmware.vmc.model_client.Nsxfirewallrule) – (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+rule_id (
long) – Rule Identifier. (required)
+nsxfirewallrule (
com.vmware.vmc.model_client.Nsxfirewallrule) – (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
update(org, sddc, edge_id, rule_id, nsxfirewallrule)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.Leaseinfo(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id)¶
+ Retrieve DHCP leaseinfo of a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.DhcpLeases
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.DhcpLeases
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id)¶
com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.Leaseinfo(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.dns_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
create(org, sddc, edge_id, enable)¶
+ Enable or disable DNS configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - enable (
bool) – Set to true to enable, set to false to disable. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+enable (
bool) – Set to true to enable, set to false to disable. (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
create(org, sddc, edge_id, enable)¶
com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config(config)¶
-
-
delete(org, sddc, edge_id)¶
+ Delete DNS server configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
delete(org, sddc, edge_id)¶
-
-
get(org, sddc, edge_id)¶
+ Retrieve DNS server configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.DnsConfig
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.DnsConfig
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id)¶
-
-
update(org, sddc, edge_id, dns_config)¶
+ Configure DNS server configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - dns_config (
com.vmware.vmc.model_client.DnsConfig) – (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+dns_config (
com.vmware.vmc.model_client.DnsConfig) – (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
update(org, sddc, edge_id, dns_config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Statistics(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id)¶
+ Retrieve DNS server statistics for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.DnsStatusAndStats
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.DnsStatusAndStats
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id)¶
com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Statistics(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
delete(org, sddc, edge_id)¶
+ Delete firewall configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
delete(org, sddc, edge_id)¶
com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config(config)¶
-
-
get(org, sddc, edge_id)¶
+ Retrieve the firewall configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.FirewallConfig
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.FirewallConfig
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id)¶
-
-
update(org, sddc, edge_id, firewall_config)¶
+ Configure firewall for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - firewall_config (
com.vmware.vmc.model_client.FirewallConfig) – (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+firewall_config (
com.vmware.vmc.model_client.FirewallConfig) – (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
update(org, sddc, edge_id, firewall_config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Statistics(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id, rule_id)¶
+ Retrieve statistics for a specific firewall rule for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - rule_id (
long) – Rule Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+rule_id (
long) – Rule Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.FirewallRuleStats
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.FirewallRuleStats
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, rule_id)¶
com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Statistics(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
delete(org, sddc, edge_id)¶
+ Delete IPsec VPN configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
delete(org, sddc, edge_id)¶
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config(config)¶
-
-
get(org, sddc, edge_id, show_sensitive_data=None)¶
+ Retrieve IPsec VPN configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - show_sensitive_data (
boolorNone) – Set to true to show sensitive data. Default value is false. -(optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+show_sensitive_data (
boolorNone) – Set to true to show sensitive data. Default value is false. +(optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.Ipsec
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Ipsec
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, show_sensitive_data=None)¶
-
-
update(org, sddc, edge_id, ipsec)¶
+ Modify IPsec VPN configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - ipsec (
com.vmware.vmc.model_client.Ipsec) – IPsec Configuration dto object. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+ipsec (
com.vmware.vmc.model_client.Ipsec) – IPsec Configuration dto object. (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
update(org, sddc, edge_id, ipsec)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Statistics(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id)¶
+ Retrieve IPsec VPN statistics for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.IpsecStatusAndStats
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.IpsecStatusAndStats
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id)¶
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Statistics(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.nat_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
delete(org, sddc, edge_id)¶
+ Delete all NAT configuration for the specified management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
delete(org, sddc, edge_id)¶
com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config(config)¶
-
-
get(org, sddc, edge_id)¶
+ Retrieve NAT configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Nat
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Nat
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id)¶
-
-
update(org, sddc, edge_id, nat)¶
+ Modify NAT configuration for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - nat (
com.vmware.vmc.model_client.Nat) – (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+nat (
com.vmware.vmc.model_client.Nat) – (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
update(org, sddc, edge_id, nat)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.Interfaces(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id, start_time=None, end_time=None)¶
+ Retrieve interface statistics for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - start_time (
longorNone) – Show statistics from this start time (in milliseconds since epoch). -(optional)
- - end_time (
longorNone) – Show statistics until this end time (in milliseconds since epoch). -(optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+start_time (
longorNone) – Show statistics from this start time (in milliseconds since epoch). +(optional)
+end_time (
longorNone) – Show statistics until this end time (in milliseconds since epoch). +(optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.CbmStatistics
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.CbmStatistics
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, start_time=None, end_time=None)¶
com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.Interfaces(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id)¶
+ Retrieve L2 VPN statistics for a compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.L2vpnStatusAndStats
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.L2vpnStatusAndStats
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id)¶
com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
add(org, sddc, edge_id, nat_rules)¶
+ Append a NAT rule for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - nat_rules (
com.vmware.vmc.model_client.NatRules) – (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+nat_rules (
com.vmware.vmc.model_client.NatRules) – (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
add(org, sddc, edge_id, nat_rules)¶
com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules(config)¶
-
-
delete(org, sddc, edge_id, rule_id)¶
+ Delete the specific NAT rule for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - rule_id (
long) – Rule Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+rule_id (
long) – Rule Identifier. (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
delete(org, sddc, edge_id, rule_id)¶
-
-
update(org, sddc, edge_id, rule_id, nsxnatrule)¶
+ Update the specific NAT rule for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - rule_id (
long) – Rule Identifier. (required)
- - nsxnatrule (
com.vmware.vmc.model_client.Nsxnatrule) – (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+rule_id (
long) – Rule Identifier. (required)
+nsxnatrule (
com.vmware.vmc.model_client.Nsxnatrule) – (required)
-
+
Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
update(org, sddc, edge_id, rule_id, nsxnatrule)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id, interval=None)¶
+ Retrieve firewall dashboard statistics for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - interval (
strorNone) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, -oneMonth, oneYear. (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+interval (
strorNone) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, +oneMonth, oneYear. (optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.DashboardStatistics
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.DashboardStatistics
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, interval=None)¶
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id, interval=None)¶
+ Retrieve interface dashboard statistics for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - interval (
strorNone) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, -oneMonth, oneYear. (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+interval (
strorNone) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, +oneMonth, oneYear. (optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.DashboardStatistics
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.DashboardStatistics
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, interval=None)¶
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id, interval=None)¶
+ Retrieve ipsec dashboard statistics for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - interval (
strorNone) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, -oneMonth, oneYear. (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+interval (
strorNone) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek, +oneMonth, oneYear. (optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.DashboardStatistics
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.DashboardStatistics
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, interval=None)¶
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.StubFactory(stub_config)¶
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id, start_time=None, end_time=None)¶
+ Retrieve internal interface statistics for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - start_time (
longorNone) – Show statistics from this start time (in milliseconds since epoch). -(optional)
- - end_time (
longorNone) – Show statistics until this end time (in milliseconds since epoch). -(optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+start_time (
longorNone) – Show statistics from this start time (in milliseconds since epoch). +(optional)
+end_time (
longorNone) – Show statistics until this end time (in milliseconds since epoch). +(optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.CbmStatistics
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.CbmStatistics
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, start_time=None, end_time=None)¶
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.StubFactory(stub_config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id, start_time=None, end_time=None)¶
+ Retrieve uplink interface statistics for a management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - start_time (
longorNone) – Show statistics from this start time (in milliseconds since epoch). -(optional)
- - end_time (
longorNone) – Show statistics until this end time (in milliseconds since epoch). -(optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+start_time (
longorNone) – Show statistics from this start time (in milliseconds since epoch). +(optional)
+end_time (
longorNone) – Show statistics until this end time (in milliseconds since epoch). +(optional)
-
+
Return type: - -Returns: com.vmware.vmc.model.CbmStatistics
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.CbmStatistics
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not provided.Raise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, start_time=None, end_time=None)¶
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink(config)¶
com.vmware.vmc.orgs.sddcs.networks.edges_client module¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id, objecttype, objectid, templateid=None)¶
+ Retrieve IPsec VPN peer configuration for a management or compute gateway (NSX Edge). The response output is free form text generated as per the template specified as request parameter input.
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - objecttype (
str) – Specify object type identifier. Valid value is ‘ipsecSiteConfig’. -Required. (required)
- - objectid (
str) – Specify object identifier, for example ‘ipsecsite-1’ for IPsec Site -configuration. Required. (required)
- - templateid (
strorNone) – Specify template identifier and response format. Valid values are -‘text’, ‘json’ and ‘xml’. Default is ‘text’. Optional. (optional)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+objecttype (
str) – Specify object type identifier. Valid value is ‘ipsecSiteConfig’. +Required. (required)
+objectid (
str) – Specify object identifier, for example ‘ipsecsite-1’ for IPsec Site +configuration. Required. (required)
+templateid (
strorNone) – Specify template identifier and response format. Valid values are +‘text’, ‘json’ and ‘xml’. Default is ‘text’. Optional. (optional)
-
+
Return type:
-vmware.vapi.struct.VapiStructReturns: DynamicStructure
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+
+vmware.vapi.struct.VapiStruct- Returns
+DynamicStructure
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, objecttype, objectid, templateid=None)¶
com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges_client.Status(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id, getlatest=None, detailed=None)¶
+ Retrieve the status of the specified management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
- - getlatest (
boolorNone) – If true, retrieve the status live from the gateway (NSX Edge). If +-
+
- Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
+getlatest (
boolorNone) – If true, retrieve the status live from the gateway (NSX Edge). If false, retrieve the latest available status from database. -(optional)
-- detailed (
boolorNone) – If true, retrieve detailed status per feature. If false, retrieve -aggregated summary of status per feature. (optional)
+(optional)
+ detailed (
boolorNone) – If true, retrieve detailed status per feature. If false, retrieve +aggregated summary of status per feature. (optional)
Return type: - -Returns: com.vmware.vmc.model.EdgeStatus
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.EdgeStatus
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id, getlatest=None, detailed=None)¶
com.vmware.vmc.orgs.sddcs.networks.edges_client.Status(config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges_client.StubFactory(stub_config)¶
+class Bases:
vmware.vapi.bindings.stub.StubFactoryBaseInitialize StubFactoryBase
--
+- - - Parameters: stub_config ( -vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance-
+
- Parameters +
stub_config (
+vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance
+
com.vmware.vmc.orgs.sddcs.networks.edges_client.StubFactory(stub_config)¶
-
-class
com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics(config)¶
+class Bases:
-vmware.vapi.bindings.stub.VapiInterface-
+- - - Parameters: config ( -vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.-
+
- Parameters +
config (
+vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
-
-
get(org, sddc, edge_id)¶
+ Retrieve all interfaces for the specified management or compute gateway (NSX Edge).
--
+- - - Parameters: -
-
- org (
str) – Organization identifier. (required)
- - sddc (
str) – Sddc Identifier. (required)
- - edge_id (
str) – Edge Identifier. (required)
+ - Parameters +
-
+
org (
str) – Organization identifier. (required)
+sddc (
str) – Sddc Identifier. (required)
+edge_id (
str) – Edge Identifier. (required)
-
+
Return type: - -Returns: com.vmware.vmc.model.Vnics
-Raise: com.vmware.vapi.std.errors_client.InvalidRequest+ +- Return type
+- +
+- Returns
+com.vmware.vmc.model.Vnics
+- Raise
+
-com.vmware.vapi.std.errors_client.InvalidRequestBad request. Request object passed is invalid.Raise: com.vmware.vapi.std.errors_client.Unauthorized+ +- Raise
+
-com.vmware.vapi.std.errors_client.UnauthorizedForbidden. Authorization header not providedRaise: com.vmware.vapi.std.errors_client.NotFound+ +- Raise
+
-com.vmware.vapi.std.errors_client.NotFoundNot found. Requested object not found.
+- org (
get(org, sddc, edge_id)¶
com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics(config)¶
This documentation explains the following:
-
-
- How the class variables are defined in the module. This specifies the names that you can use in your program. -
- How you instantiate a class to use it for communication with future versions of the service. +
How the class variables are defined in the module. This specifies the names that you can use in your program.
+How you instantiate a class to use it for communication with future versions of the service.
Example of an enumerated type documentation¶
--
-
- class com.vmware.vapi.metadata_client. SourceType (string) -
Bases: vmware.vapi.bindings.enum.Enum
+-
+
- class com.vmware.vapi.metadata_client. SourceType (string)
Bases: vmware.vapi.bindings.enum.Enum
Metadata source type
-Note
-This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See enumerated type description page.
+Note
+This class represents an enumerated type in the interface language definition type system. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate this class. See enumerated type description page.
Parameters : string (
-str) – String value for the SourceType instance.-
-
- FILE = SourceType(string=’FILE’) -
- If the source is backed by a file. -
- REMOTE = SourceType(string=’REMOTE’) -
- If the source is backed by a remote service. +
- FILE = SourceType(string=’FILE’)
If the source is backed by a file.
+
+- REMOTE = SourceType(string=’REMOTE’)
If the source is backed by a remote service.
+
-
+
The enumerated type classes are defined in python modules that your code imports. You can use these in your code.
-
-
- If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class. +
If you want to pass an enumerated type value in a method to a server, specify the class variable of the enumerated type class.
# SourceType is an enumerated type from com.vmware.vapi.metadata_client import SourceType @@ -199,7 +198,7 @@ imports. You can use these in your code.
-
-
- When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values. +
When you receive an enumerated type value in the response from a server, allow for unknown enumerated type values.
# SourceType is an enumerated type from com.vmware.vapi.metadata_client import SourceType @@ -215,7 +214,7 @@ imports. You can use these in your code.
-
-
- Sending a new enumerated type value to a server that has a newer version of the enumerated type. +
Sending a new enumerated type value to a server that has a newer version of the enumerated type.
To use new values of the enumerated type in communication with a server that supports a newer version of the API, you instantiate the enumerated type class.
diff --git a/vmc/genindex.html b/vmc/genindex.html index 0c2c8aa7..07f6345e 100644 --- a/vmc/genindex.html +++ b/vmc/genindex.html @@ -9,7 +9,7 @@ -Index — VMware Cloud on AWS Console API 1.5.0 documentation +Index — VMware Cloud on AWS Console API 1.6.0 documentation @@ -59,7 +59,7 @@- 1.5.0 + 1.6.0@@ -280,8 +280,6 @@- CloudProvider (class in com.vmware.vmc.model_client)
- Cluster (class in com.vmware.vmc.model_client) -
-- cluster_id (com.vmware.vmc.model_client.Cluster attribute)
- CLUSTER_STATE_ADDING_HOSTS (com.vmware.vmc.model_client.Cluster attribute)
@@ -349,10 +347,10 @@- com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client (module)
- -+ - -
-
- provider (com.vmware.vmc.model_client.Agent attribute) +
- provider() (com.vmware.vmc.model_client.Agent property)
-
-
- (com.vmware.vmc.model_client.AwsAgent attribute) +
- (com.vmware.vmc.model_client.AwsAgent property) -
- (com.vmware.vmc.model_client.AwsCloudProvider attribute) +
- (com.vmware.vmc.model_client.AwsCloudProvider property) -
- (com.vmware.vmc.model_client.AwsEsxHost attribute) +
- (com.vmware.vmc.model_client.AwsEsxHost property) -
- (com.vmware.vmc.model_client.AwsSddcConfig attribute) +
- (com.vmware.vmc.model_client.AwsSddcConfig property) -
- (com.vmware.vmc.model_client.AwsSddcResourceConfig attribute) +
- (com.vmware.vmc.model_client.AwsSddcResourceConfig property) -
- (com.vmware.vmc.model_client.CloudProvider attribute) +
- (com.vmware.vmc.model_client.CloudProvider property) -
- (com.vmware.vmc.model_client.EsxHost attribute) +
- (com.vmware.vmc.model_client.EsxHost property) -
- (com.vmware.vmc.model_client.SddcConfig attribute) +
- (com.vmware.vmc.model_client.SddcConfig property) -
- (com.vmware.vmc.model_client.SddcResourceConfig attribute) +
- (com.vmware.vmc.model_client.SddcResourceConfig property)
+
- PROVIDER_AWS (com.vmware.vmc.model_client.Sddc attribute)
-
@@ -1112,6 +1110,10 @@
- Providers (class in com.vmware.vmc.orgs_client)
- Public (class in com.vmware.vmc.orgs.sddcs.dns_client) + +
- PUBLIC_CSP_URL (in module vmware.vapi.vmc.client) + +
- PUBLIC_VMC_URL (in module vmware.vapi.vmc.client)
- Publicips (class in com.vmware.vmc.orgs.sddcs_client) diff --git a/vmc/index.html b/vmc/index.html index cb7d995e..86b4b31b 100644 --- a/vmc/index.html +++ b/vmc/index.html @@ -8,7 +8,7 @@ -
-
+
vmware.vapi.vmc.client.PUBLIC_CSP_URL= 'https://console.cloud.vmware.com'¶
+ -
+
vmware.vapi.vmc.client.PUBLIC_VMC_URL= 'https://vmc.vmware.com/'¶
+ -
-class
vmware.vapi.vmc.client.VmcClient(session, refresh_token, vmc_url, csp_url)¶
+class Bases:
vmware.vapi.bindings.stub.ApiClientVMC Client class that providess access to stubs for all the services in the VMC API
Initialize VmcClient by creating a stub factory instance using a CSP Security context filter added to the filter chain of the connector
--
+- - - Parameters: -
-
- session (
requests.Session) – Requests HTTP session instance
- - refresh_token (
str) – Refresh token obtained from CSP
- - vmc_url (
str) – URL of the VMC service
- - csp_url (
str) – URL of the CSP service
+ - Parameters +
-
+
session (
requests.Session) – Requests HTTP session instance
+refresh_token (
str) – Refresh token obtained from CSP
+vmc_url (
str) – URL of the VMC service
+csp_url (
str) – URL of the CSP service
-
+
+- session (
-
-
vmware.vapi.vmc.client.create_vmc_client(refresh_token, session=None)¶
+ Helper method to create an instance of the VMC API client using the public VMC and CSP URL.
--
+- - - Parameters: -
-
- refresh_token (
str) – Refresh token obtained from CSP
- - session (
requests.SessionorNone) – Requests HTTP session instance. If not specified, then one -is automatically created and used
+ - Parameters +
-
+
refresh_token (
str) – Refresh token obtained from CSP
+session (
requests.SessionorNone) – Requests HTTP session instance. If not specified, then one +is automatically created and used
-
+
Return type: - -Returns: VMC Client instance
-
+- refresh_token (
- Return type +
- + +
- Returns +
VMC Client instance
+
+
Welcome to VMware Cloud on AWS Console API’s documentation! — VMware Cloud on AWS Console API 1.5.0 documentation +Welcome to VMware Cloud on AWS Console API’s documentation! — VMware Cloud on AWS Console API 1.6.0 documentation @@ -59,7 +59,7 @@- 1.5.0 + 1.6.0@@ -226,9 +226,9 @@diff --git a/vmc/objects.inv b/vmc/objects.inv index a076f4e5..10f3ecef 100644 Binary files a/vmc/objects.inv and b/vmc/objects.inv differ diff --git a/vmc/py-modindex.html b/vmc/py-modindex.html index 2f15eb93..c998ac5c 100644 --- a/vmc/py-modindex.html +++ b/vmc/py-modindex.html @@ -8,7 +8,7 @@ -Indices and tables¶
Python Module Index — VMware Cloud on AWS Console API 1.5.0 documentation +Python Module Index — VMware Cloud on AWS Console API 1.6.0 documentation @@ -61,7 +61,7 @@- 1.5.0 + 1.6.0diff --git a/vmc/search.html b/vmc/search.html index 73c827b7..c63203a9 100644 --- a/vmc/search.html +++ b/vmc/search.html @@ -8,7 +8,7 @@ -Search — VMware Cloud on AWS Console API 1.5.0 documentation +Search — VMware Cloud on AWS Console API 1.6.0 documentation @@ -59,7 +59,7 @@- 1.5.0 + 1.6.0diff --git a/vmc/searchindex.js b/vmc/searchindex.js index 7ca249d3..0b2a2206 100644 --- a/vmc/searchindex.js +++ b/vmc/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["com","com.vmware","com.vmware.vmc","com.vmware.vmc.orgs","com.vmware.vmc.orgs.sddcs","com.vmware.vmc.orgs.sddcs.networks","com.vmware.vmc.orgs.sddcs.networks.cgws","com.vmware.vmc.orgs.sddcs.networks.edges","com.vmware.vmc.orgs.sddcs.networks.edges.firewall","com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn","com.vmware.vmc.orgs.sddcs.networks.edges.nat","com.vmware.vmc.orgs.sddcs.networks.edges.statistics","enumeration","index","vmware","vmware.vapi","vmware.vapi.vmc"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:54},filenames:["com.rst","com.vmware.rst","com.vmware.vmc.rst","com.vmware.vmc.orgs.rst","com.vmware.vmc.orgs.sddcs.rst","com.vmware.vmc.orgs.sddcs.networks.rst","com.vmware.vmc.orgs.sddcs.networks.cgws.rst","com.vmware.vmc.orgs.sddcs.networks.edges.rst","com.vmware.vmc.orgs.sddcs.networks.edges.firewall.rst","com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.rst","com.vmware.vmc.orgs.sddcs.networks.edges.nat.rst","com.vmware.vmc.orgs.sddcs.networks.edges.statistics.rst","enumeration.rst","index.rst","vmware.rst","vmware.vapi.rst","vmware.vapi.vmc.rst"],objects:{"":{com:[0,0,0,"-"],vmware:[14,0,0,"-"]},"com.vmware":{vmc:[2,0,0,"-"],vmc_client:[1,0,0,"-"]},"com.vmware.vmc":{model_client:[2,0,0,"-"],orgs:[3,0,0,"-"],orgs_client:[2,0,0,"-"]},"com.vmware.vmc.model_client":{AbstractEntity:[2,1,1,""],AccountLinkConfig:[2,1,1,""],AccountLinkSddcConfig:[2,1,1,""],AddressFWSourceDestination:[2,1,1,""],Agent:[2,1,1,""],AmiInfo:[2,1,1,""],AppliancesSummary:[2,1,1,""],Application:[2,1,1,""],AwsAgent:[2,1,1,""],AwsCloudProvider:[2,1,1,""],AwsCompatibleSubnets:[2,1,1,""],AwsCustomerConnectedAccount:[2,1,1,""],AwsEsxHost:[2,1,1,""],AwsKeyPair:[2,1,1,""],AwsKmsInfo:[2,1,1,""],AwsSddcConfig:[2,1,1,""],AwsSddcConnection:[2,1,1,""],AwsSddcResourceConfig:[2,1,1,""],AwsSubnet:[2,1,1,""],CaCertificates:[2,1,1,""],CbmStatistic:[2,1,1,""],CbmStatistics:[2,1,1,""],CbmStatsData:[2,1,1,""],CloudProvider:[2,1,1,""],Cluster:[2,1,1,""],ClusterConfig:[2,1,1,""],ComputeGatewayTemplate:[2,1,1,""],ConnectivityAgentValidation:[2,1,1,""],ConnectivityValidationGroup:[2,1,1,""],ConnectivityValidationGroups:[2,1,1,""],ConnectivityValidationInput:[2,1,1,""],ConnectivityValidationSubGroup:[2,1,1,""],CrlCertificates:[2,1,1,""],CustomerEniInfo:[2,1,1,""],DashboardData:[2,1,1,""],DashboardStat:[2,1,1,""],DashboardStatistics:[2,1,1,""],DataPageEdgeSummary:[2,1,1,""],DataPageSddcNetwork:[2,1,1,""],DataPermissions:[2,1,1,""],DhcpLeaseInfo:[2,1,1,""],DhcpLeases:[2,1,1,""],DnsConfig:[2,1,1,""],DnsForwarders:[2,1,1,""],DnsListeners:[2,1,1,""],DnsResponseStats:[2,1,1,""],DnsStatusAndStats:[2,1,1,""],DnsView:[2,1,1,""],DnsViewMatch:[2,1,1,""],DnsViews:[2,1,1,""],EdgeJob:[2,1,1,""],EdgeStatus:[2,1,1,""],EdgeSummary:[2,1,1,""],EdgeVmStatus:[2,1,1,""],EdgeVnicAddressGroup:[2,1,1,""],EdgeVnicAddressGroups:[2,1,1,""],EniInfo:[2,1,1,""],ErrorResponse:[2,1,1,""],EsxConfig:[2,1,1,""],EsxHost:[2,1,1,""],ExtendedAttribute:[2,1,1,""],FeatureCapabilities:[2,1,1,""],FeatureCapability:[2,1,1,""],FeatureStatus:[2,1,1,""],FirewallConfig:[2,1,1,""],FirewallDashboardStats:[2,1,1,""],FirewallDefaultPolicy:[2,1,1,""],FirewallGlobalConfig:[2,1,1,""],FirewallRule:[2,1,1,""],FirewallRuleScope:[2,1,1,""],FirewallRuleStats:[2,1,1,""],FirewallRules:[2,1,1,""],FirewallService:[2,1,1,""],GatewayTemplate:[2,1,1,""],GlcmBundle:[2,1,1,""],HostLeaseInfo:[2,1,1,""],InteractionPermissions:[2,1,1,""],InterfacesDashboardStats:[2,1,1,""],IpAddresses:[2,1,1,""],Ipsec:[2,1,1,""],IpsecDashboardStats:[2,1,1,""],IpsecGlobalConfig:[2,1,1,""],IpsecSite:[2,1,1,""],IpsecSiteIKEStatus:[2,1,1,""],IpsecSiteStats:[2,1,1,""],IpsecSites:[2,1,1,""],IpsecStatusAndStats:[2,1,1,""],IpsecTunnelStats:[2,1,1,""],KeyValueAttributes:[2,1,1,""],KmsVpcEndpoint:[2,1,1,""],L2Extension:[2,1,1,""],L2Vpn:[2,1,1,""],L2vpnStats:[2,1,1,""],L2vpnStatusAndStats:[2,1,1,""],LicenceAclPermissions:[2,1,1,""],LoadBalancerDashboardStats:[2,1,1,""],Logging:[2,1,1,""],LogicalNetwork:[2,1,1,""],LogicalRouterScope:[2,1,1,""],LogicalRouterScopes:[2,1,1,""],MacAddress:[2,1,1,""],MaintenanceWindow:[2,1,1,""],MaintenanceWindowEntry:[2,1,1,""],MaintenanceWindowGet:[2,1,1,""],ManagementGatewayTemplate:[2,1,1,""],MapZonesRequest:[2,1,1,""],MetaDashboardStats:[2,1,1,""],Metadata:[2,1,1,""],Nat:[2,1,1,""],NatRule:[2,1,1,""],NatRules:[2,1,1,""],NetworkTemplate:[2,1,1,""],NewCredentials:[2,1,1,""],Nsxfirewallrule:[2,1,1,""],Nsxfirewallservice:[2,1,1,""],Nsxl2vpn:[2,1,1,""],Nsxnatrule:[2,1,1,""],Nsxsite:[2,1,1,""],NsxtAddons:[2,1,1,""],ObjectType:[2,1,1,""],OfferInstancesHolder:[2,1,1,""],OfferType:[2,1,1,""],OnDemandOfferInstance:[2,1,1,""],OrgProperties:[2,1,1,""],Organization:[2,1,1,""],PagedEdgeList:[2,1,1,""],PagingInfo:[2,1,1,""],PopAgentXeniConnection:[2,1,1,""],PopAmiInfo:[2,1,1,""],PopInfo:[2,1,1,""],PopServiceInfo:[2,1,1,""],Requests:[2,1,1,""],Reservation:[2,1,1,""],ReservationInMw:[2,1,1,""],ReservationSchedule:[2,1,1,""],ReservationWindow:[2,1,1,""],ReservationWindowMaintenanceProperties:[2,1,1,""],Result:[2,1,1,""],ScopeInfo:[2,1,1,""],Sddc:[2,1,1,""],SddcAllocatePublicIpSpec:[2,1,1,""],SddcConfig:[2,1,1,""],SddcId:[2,1,1,""],SddcLinkConfig:[2,1,1,""],SddcManifest:[2,1,1,""],SddcNetwork:[2,1,1,""],SddcNetworkAddressGroup:[2,1,1,""],SddcNetworkAddressGroups:[2,1,1,""],SddcNetworkDhcpConfig:[2,1,1,""],SddcNetworkDhcpIpPool:[2,1,1,""],SddcPatchRequest:[2,1,1,""],SddcPublicIp:[2,1,1,""],SddcResourceConfig:[2,1,1,""],SddcStateRequest:[2,1,1,""],SddcTemplate:[2,1,1,""],SecondaryAddresses:[2,1,1,""],ServiceError:[2,1,1,""],Site:[2,1,1,""],Sites:[2,1,1,""],SslvpnDashboardStats:[2,1,1,""],StubFactory:[2,1,1,""],SubInterface:[2,1,1,""],SubInterfaces:[2,1,1,""],SubnetInfo:[2,1,1,""],Subnets:[2,1,1,""],SubscriptionDetails:[2,1,1,""],SubscriptionProducts:[2,1,1,""],SubscriptionRequest:[2,1,1,""],SupportWindow:[2,1,1,""],SupportWindowId:[2,1,1,""],Task:[2,1,1,""],TaskProgressPhase:[2,1,1,""],TermOfferInstance:[2,1,1,""],TrafficShapingPolicy:[2,1,1,""],UpdateCredentials:[2,1,1,""],VmcLocale:[2,1,1,""],Vnic:[2,1,1,""],Vnics:[2,1,1,""],VpcInfo:[2,1,1,""],VpcInfoSubnets:[2,1,1,""],Vpn:[2,1,1,""],VpnChannelStatus:[2,1,1,""],VpnTunnelStatus:[2,1,1,""],VpnTunnelTrafficStats:[2,1,1,""],VsanConfigConstraints:[2,1,1,""],VsanEncryptionConfig:[2,1,1,""]},"com.vmware.vmc.model_client.Agent":{AGENT_STATE_CUSTOMIZING:[2,2,1,""],AGENT_STATE_DELETED:[2,2,1,""],AGENT_STATE_DELETING:[2,2,1,""],AGENT_STATE_DEPLOYING:[2,2,1,""],AGENT_STATE_FAILED:[2,2,1,""],AGENT_STATE_NOT_READY:[2,2,1,""],AGENT_STATE_READY:[2,2,1,""],provider:[2,2,1,""]},"com.vmware.vmc.model_client.AwsAgent":{provider:[2,2,1,""]},"com.vmware.vmc.model_client.AwsCloudProvider":{provider:[2,2,1,""]},"com.vmware.vmc.model_client.AwsCustomerConnectedAccount":{STATE_ACTIVE:[2,2,1,""],STATE_BROKEN:[2,2,1,""],STATE_DELETED:[2,2,1,""]},"com.vmware.vmc.model_client.AwsEsxHost":{provider:[2,2,1,""]},"com.vmware.vmc.model_client.AwsSddcConfig":{provider:[2,2,1,""]},"com.vmware.vmc.model_client.AwsSddcConnection":{STATE_ACTIVE:[2,2,1,""],STATE_BROKEN:[2,2,1,""],STATE_DELETED:[2,2,1,""]},"com.vmware.vmc.model_client.AwsSddcResourceConfig":{provider:[2,2,1,""]},"com.vmware.vmc.model_client.CloudProvider":{provider:[2,2,1,""]},"com.vmware.vmc.model_client.Cluster":{CLUSTER_STATE_ADDING_HOSTS:[2,2,1,""],CLUSTER_STATE_DEPLOYING:[2,2,1,""],CLUSTER_STATE_FAILED:[2,2,1,""],CLUSTER_STATE_READY:[2,2,1,""],cluster_id:[2,2,1,""]},"com.vmware.vmc.model_client.ConnectivityAgentValidation":{SOURCE_SRM:[2,2,1,""],SOURCE_VCENTER:[2,2,1,""],SOURCE_VR:[2,2,1,""],TYPE_CONNECTIVITY:[2,2,1,""],TYPE_CURL:[2,2,1,""],TYPE_DNS:[2,2,1,""],TYPE_PING:[2,2,1,""],TYPE_TRACEROUTE:[2,2,1,""]},"com.vmware.vmc.model_client.ConnectivityValidationGroup":{ID_DRAAS:[2,2,1,""],ID_HLM:[2,2,1,""]},"com.vmware.vmc.model_client.ConnectivityValidationInput":{ID_HOSTNAME:[2,2,1,""],ID_HOSTNAME_OR_IP:[2,2,1,""],ID_HOST_IP:[2,2,1,""]},"com.vmware.vmc.model_client.ConnectivityValidationSubGroup":{ID_ACTIVE_DIRECTORY:[2,2,1,""],ID_DRAAS_ONPREM_PSC:[2,2,1,""],ID_DRAAS_ONPREM_SRM:[2,2,1,""],ID_DRAAS_ONPREM_VCENTER:[2,2,1,""],ID_DRAAS_ONPREM_VR:[2,2,1,""],ID_ONPREM_ESX:[2,2,1,""],ID_ONPREM_PSC:[2,2,1,""],ID_ONPREM_VCENTER:[2,2,1,""],ID_PRIMARY_DNS:[2,2,1,""],ID_SECONDARY_DNS:[2,2,1,""]},"com.vmware.vmc.model_client.EsxHost":{ESX_STATE_DELETED:[2,2,1,""],ESX_STATE_DELETING:[2,2,1,""],ESX_STATE_DEPLOYING:[2,2,1,""],ESX_STATE_FAILED:[2,2,1,""],ESX_STATE_PROVISIONED:[2,2,1,""],ESX_STATE_READY:[2,2,1,""],provider:[2,2,1,""]},"com.vmware.vmc.model_client.FirewallRule":{ACTION_ALLOW:[2,2,1,""],ACTION_DENY:[2,2,1,""],RULE_TYPE_DEFAULT:[2,2,1,""],RULE_TYPE_USER:[2,2,1,""]},"com.vmware.vmc.model_client.FirewallRuleScope":{VNIC_GROUP_IDS_EXTERNAL:[2,2,1,""],VNIC_GROUP_IDS_INTERNAL:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_0:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_1:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_2:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_3:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_4:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_5:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_6:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_7:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_8:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_9:[2,2,1,""],VNIC_GROUP_IDS_VSE:[2,2,1,""]},"com.vmware.vmc.model_client.LogicalNetwork":{NETWORK_TYPE_EXTENDED:[2,2,1,""],NETWORK_TYPE_HOSTED:[2,2,1,""],NETWORK_TYPE_ROUTED:[2,2,1,""]},"com.vmware.vmc.model_client.MaintenanceWindow":{DAY_OF_WEEK_FRIDAY:[2,2,1,""],DAY_OF_WEEK_MONDAY:[2,2,1,""],DAY_OF_WEEK_SATURDAY:[2,2,1,""],DAY_OF_WEEK_SUNDAY:[2,2,1,""],DAY_OF_WEEK_THURSDAY:[2,2,1,""],DAY_OF_WEEK_TUESDAY:[2,2,1,""],DAY_OF_WEEK_WEDNESDAY:[2,2,1,""]},"com.vmware.vmc.model_client.MaintenanceWindowGet":{DAY_OF_WEEK_FRIDAY:[2,2,1,""],DAY_OF_WEEK_MONDAY:[2,2,1,""],DAY_OF_WEEK_SATURDAY:[2,2,1,""],DAY_OF_WEEK_SUNDAY:[2,2,1,""],DAY_OF_WEEK_THURSDAY:[2,2,1,""],DAY_OF_WEEK_TUESDAY:[2,2,1,""],DAY_OF_WEEK_WEDNESDAY:[2,2,1,""]},"com.vmware.vmc.model_client.NatRule":{ACTION_DNAT:[2,2,1,""],ACTION_SNAT:[2,2,1,""]},"com.vmware.vmc.model_client.OfferType":{ON_DEMAND:[2,2,1,""],TERM:[2,2,1,""]},"com.vmware.vmc.model_client.Organization":{PROJECT_STATE_CREATED:[2,2,1,""],PROJECT_STATE_DELETED:[2,2,1,""]},"com.vmware.vmc.model_client.PopAmiInfo":{TYPE_CENTOS:[2,2,1,""],TYPE_POP:[2,2,1,""]},"com.vmware.vmc.model_client.PopServiceInfo":{SERVICE_AGENT:[2,2,1,""],SERVICE_AIDE:[2,2,1,""],SERVICE_BRE:[2,2,1,""],SERVICE_BRF:[2,2,1,""],SERVICE_DNS:[2,2,1,""],SERVICE_DOCKER:[2,2,1,""],SERVICE_FM_LOG_COLLECTOR:[2,2,1,""],SERVICE_FM_METRICS_COLLECTOR:[2,2,1,""],SERVICE_FORWARD_PROXY:[2,2,1,""],SERVICE_GLCM:[2,2,1,""],SERVICE_JRE:[2,2,1,""],SERVICE_LOGZ_LOG_COLLECTOR:[2,2,1,""],SERVICE_NTP:[2,2,1,""],SERVICE_OS:[2,2,1,""],SERVICE_REVERSE_PROXY:[2,2,1,""],SERVICE_RTS:[2,2,1,""],SERVICE_S3_ADAPTER:[2,2,1,""]},"com.vmware.vmc.model_client.ReservationSchedule":{DAY_OF_WEEK_FRIDAY:[2,2,1,""],DAY_OF_WEEK_MONDAY:[2,2,1,""],DAY_OF_WEEK_SATURDAY:[2,2,1,""],DAY_OF_WEEK_SUNDAY:[2,2,1,""],DAY_OF_WEEK_THURSDAY:[2,2,1,""],DAY_OF_WEEK_TUESDAY:[2,2,1,""],DAY_OF_WEEK_WEDNESDAY:[2,2,1,""]},"com.vmware.vmc.model_client.ReservationWindow":{RESERVATION_STATE_CANCELED:[2,2,1,""],RESERVATION_STATE_COMPLETED:[2,2,1,""],RESERVATION_STATE_RUNNING:[2,2,1,""],RESERVATION_STATE_SCHEDULED:[2,2,1,""]},"com.vmware.vmc.model_client.Sddc":{ACCOUNT_LINK_STATE_DELAYED:[2,2,1,""],ACCOUNT_LINK_STATE_LINKED:[2,2,1,""],ACCOUNT_LINK_STATE_UNLINKED:[2,2,1,""],PROVIDER_AWS:[2,2,1,""],SDDC_STATE_DELETED:[2,2,1,""],SDDC_STATE_DELETING:[2,2,1,""],SDDC_STATE_DELETION_FAILED:[2,2,1,""],SDDC_STATE_DEPLOYING:[2,2,1,""],SDDC_STATE_FAILED:[2,2,1,""],SDDC_STATE_READY:[2,2,1,""]},"com.vmware.vmc.model_client.SddcConfig":{DEPLOYMENT_TYPE_MULTIAZ:[2,2,1,""],DEPLOYMENT_TYPE_SINGLEAZ:[2,2,1,""],PROVIDER_AWS:[2,2,1,""],provider:[2,2,1,""]},"com.vmware.vmc.model_client.SddcResourceConfig":{DEPLOYMENT_TYPE_MULTI_AZ:[2,2,1,""],DEPLOYMENT_TYPE_SINGLE_AZ:[2,2,1,""],PROVIDER_AWS:[2,2,1,""],provider:[2,2,1,""]},"com.vmware.vmc.model_client.SddcStateRequest":{STATES_CANCELED:[2,2,1,""],STATES_COMPLETED:[2,2,1,""],STATES_RUNNING:[2,2,1,""],STATES_SCHEDULED:[2,2,1,""]},"com.vmware.vmc.model_client.SddcTemplate":{STATE_APPLIED:[2,2,1,""],STATE_AVAILABLE:[2,2,1,""],STATE_DELETED:[2,2,1,""],STATE_DELETING:[2,2,1,""],STATE_FAILED:[2,2,1,""],STATE_INITIALIZATION:[2,2,1,""],STATE_INUSE:[2,2,1,""]},"com.vmware.vmc.model_client.Site":{TUNNEL_STATUS_CONNECTED:[2,2,1,""],TUNNEL_STATUS_DISCONNECTED:[2,2,1,""],TUNNEL_STATUS_UNKNOWN:[2,2,1,""]},"com.vmware.vmc.model_client.SubscriptionDetails":{STATUS_ACTIVATED:[2,2,1,""],STATUS_CANCELLED:[2,2,1,""],STATUS_CREATED:[2,2,1,""],STATUS_EXPIRED:[2,2,1,""],STATUS_FAILED:[2,2,1,""],STATUS_ORDER_SUBMITTED:[2,2,1,""],STATUS_PENDING_PROVISIONING:[2,2,1,""]},"com.vmware.vmc.model_client.SupportWindow":{START_DAY_FRIDAY:[2,2,1,""],START_DAY_MONDAY:[2,2,1,""],START_DAY_SATURDAY:[2,2,1,""],START_DAY_SUNDAY:[2,2,1,""],START_DAY_THURSDAY:[2,2,1,""],START_DAY_TUESDAY:[2,2,1,""],START_DAY_WEDNESDAY:[2,2,1,""]},"com.vmware.vmc.model_client.Task":{STATUS_CANCELED:[2,2,1,""],STATUS_CANCELING:[2,2,1,""],STATUS_FAILED:[2,2,1,""],STATUS_FINISHED:[2,2,1,""],STATUS_STARTED:[2,2,1,""]},"com.vmware.vmc.model_client.Vpn":{AUTHENTICATION_PSK:[2,2,1,""],AUTHENTICATION_UNKNOWN:[2,2,1,""],DH_GROUP_DH14:[2,2,1,""],DH_GROUP_DH15:[2,2,1,""],DH_GROUP_DH16:[2,2,1,""],DH_GROUP_DH2:[2,2,1,""],DH_GROUP_DH5:[2,2,1,""],DH_GROUP_UNKNOWN:[2,2,1,""],DIGEST_ALGORITHM_SHA1:[2,2,1,""],DIGEST_ALGORITHM_SHA_256:[2,2,1,""],ENCRYPTION_AES256:[2,2,1,""],ENCRYPTION_AES:[2,2,1,""],ENCRYPTION_AES_GCM:[2,2,1,""],ENCRYPTION_TRIPLE_DES:[2,2,1,""],ENCRYPTION_UNKNOWN:[2,2,1,""],IKE_OPTION_IKEV1:[2,2,1,""],IKE_OPTION_IKEV2:[2,2,1,""],STATE_CONNECTED:[2,2,1,""],STATE_DISCONNECTED:[2,2,1,""],STATE_PARTIALLY_CONNECTED:[2,2,1,""],STATE_UNKNOWN:[2,2,1,""]},"com.vmware.vmc.model_client.VpnChannelStatus":{CHANNEL_STATUS_CONNECTED:[2,2,1,""],CHANNEL_STATUS_DISCONNECTED:[2,2,1,""],CHANNEL_STATUS_UNKNOWN:[2,2,1,""]},"com.vmware.vmc.model_client.VpnTunnelStatus":{TUNNEL_STATUS_CONNECTED:[2,2,1,""],TUNNEL_STATUS_DISCONNECTED:[2,2,1,""],TUNNEL_STATUS_UNKNOWN:[2,2,1,""]},"com.vmware.vmc.orgs":{account_link_client:[3,0,0,"-"],reservations_client:[3,0,0,"-"],sddcs:[4,0,0,"-"],sddcs_client:[3,0,0,"-"],storage_client:[3,0,0,"-"],subscriptions_client:[3,0,0,"-"],tbrs_client:[3,0,0,"-"]},"com.vmware.vmc.orgs.account_link_client":{CompatibleSubnets:[3,1,1,""],CompatibleSubnetsAsync:[3,1,1,""],ConnectedAccounts:[3,1,1,""],MapCustomerZones:[3,1,1,""],SddcConnections:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.vmc.orgs.account_link_client.CompatibleSubnets":{get:[3,3,1,""],post:[3,3,1,""]},"com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync":{get:[3,3,1,""],post:[3,3,1,""]},"com.vmware.vmc.orgs.account_link_client.ConnectedAccounts":{"delete":[3,3,1,""],get:[3,3,1,""]},"com.vmware.vmc.orgs.account_link_client.MapCustomerZones":{post:[3,3,1,""]},"com.vmware.vmc.orgs.account_link_client.SddcConnections":{get:[3,3,1,""]},"com.vmware.vmc.orgs.reservations_client":{Mw:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.vmc.orgs.reservations_client.Mw":{get:[3,3,1,""],put:[3,3,1,""]},"com.vmware.vmc.orgs.sddcs":{addons_client:[4,0,0,"-"],dns_client:[4,0,0,"-"],management_vms_client:[4,0,0,"-"],networking_client:[4,0,0,"-"],networks:[5,0,0,"-"],networks_client:[4,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.addons_client":{Credentials:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.vmc.orgs.sddcs.addons_client.Credentials":{CREATE_ADDON_TYPE_HCX:[4,2,1,""],GET_ADDON_TYPE_HCX:[4,2,1,""],LIST_ADDON_TYPE_HCX:[4,2,1,""],UPDATE_ADDON_TYPE_HCX:[4,2,1,""],create:[4,3,1,""],get:[4,3,1,""],list:[4,3,1,""],update:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.dns_client":{Private:[4,1,1,""],Public:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.vmc.orgs.sddcs.dns_client.Private":{update:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.dns_client.Public":{update:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.management_vms_client":{Dns:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.vmc.orgs.sddcs.management_vms_client.Dns":{UPDATE_IP_TYPE_PRIVATE:[4,2,1,""],UPDATE_IP_TYPE_PUBLIC:[4,2,1,""],update:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.networking_client":{ConnectivityTests:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests":{get:[4,3,1,""],post:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks":{cgws:[6,0,0,"-"],edges:[7,0,0,"-"],edges_client:[5,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.cgws":{l2vpn_client:[6,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client":{Config:[6,1,1,""],StubFactory:[6,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config":{"delete":[6,3,1,""],get:[6,3,1,""],update:[6,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges":{dhcp_client:[7,0,0,"-"],dns_client:[7,0,0,"-"],firewall:[8,0,0,"-"],firewall_client:[7,0,0,"-"],ipsec_client:[7,0,0,"-"],l2vpn:[9,0,0,"-"],nat:[10,0,0,"-"],nat_client:[7,0,0,"-"],statistics:[11,0,0,"-"],statistics_client:[7,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client":{Leaseinfo:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.Leaseinfo":{get:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.dns_client":{Config:[7,1,1,""],Statistics:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config":{"delete":[7,3,1,""],create:[7,3,1,""],get:[7,3,1,""],update:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Statistics":{get:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall":{config_client:[8,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client":{Rules:[8,1,1,""],StubFactory:[8,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules":{"delete":[8,3,1,""],add:[8,3,1,""],get:[8,3,1,""],update:[8,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client":{Config:[7,1,1,""],Statistics:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config":{"delete":[7,3,1,""],get:[7,3,1,""],update:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Statistics":{get:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client":{Config:[7,1,1,""],Statistics:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config":{"delete":[7,3,1,""],get:[7,3,1,""],update:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Statistics":{get:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn":{config_client:[9,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client":{Statistics:[9,1,1,""],StubFactory:[9,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics":{get:[9,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.nat":{config_client:[10,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client":{Rules:[10,1,1,""],StubFactory:[10,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules":{"delete":[10,3,1,""],add:[10,3,1,""],update:[10,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.nat_client":{Config:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config":{"delete":[7,3,1,""],get:[7,3,1,""],update:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics":{dashboard_client:[11,0,0,"-"],interfaces_client:[11,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client":{Firewall:[11,1,1,""],Interface:[11,1,1,""],Ipsec:[11,1,1,""],StubFactory:[11,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall":{get:[11,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface":{get:[11,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec":{get:[11,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client":{Internal:[11,1,1,""],StubFactory:[11,1,1,""],Uplink:[11,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal":{get:[11,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink":{get:[11,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client":{Interfaces:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.Interfaces":{get:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges_client":{Peerconfig:[5,1,1,""],Status:[5,1,1,""],StubFactory:[5,1,1,""],Vnics:[5,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig":{get:[5,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges_client.Status":{get:[5,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics":{get:[5,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks_client":{Edges:[4,1,1,""],Logical:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks_client.Edges":{get:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks_client.Logical":{"delete":[4,3,1,""],create:[4,3,1,""],get:[4,3,1,""],get_0:[4,3,1,""],update:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs_client":{Clusters:[3,1,1,""],Convert:[3,1,1,""],Esxs:[3,1,1,""],Publicips:[3,1,1,""],SddcTemplate:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.vmc.orgs.sddcs_client.Clusters":{"delete":[3,3,1,""],create:[3,3,1,""]},"com.vmware.vmc.orgs.sddcs_client.Convert":{create:[3,3,1,""]},"com.vmware.vmc.orgs.sddcs_client.Esxs":{create:[3,3,1,""]},"com.vmware.vmc.orgs.sddcs_client.Publicips":{"delete":[3,3,1,""],create:[3,3,1,""],get:[3,3,1,""],list:[3,3,1,""],update:[3,3,1,""]},"com.vmware.vmc.orgs.sddcs_client.SddcTemplate":{get:[3,3,1,""]},"com.vmware.vmc.orgs.storage_client":{ClusterConstraints:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.vmc.orgs.storage_client.ClusterConstraints":{get:[3,3,1,""]},"com.vmware.vmc.orgs.subscriptions_client":{OfferInstances:[3,1,1,""],Products:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.vmc.orgs.subscriptions_client.OfferInstances":{list:[3,3,1,""]},"com.vmware.vmc.orgs.subscriptions_client.Products":{list:[3,3,1,""]},"com.vmware.vmc.orgs.tbrs_client":{Reservation:[3,1,1,""],StubFactory:[3,1,1,""],SupportWindow:[3,1,1,""]},"com.vmware.vmc.orgs.tbrs_client.Reservation":{post:[3,3,1,""]},"com.vmware.vmc.orgs.tbrs_client.SupportWindow":{get:[3,3,1,""],put:[3,3,1,""]},"com.vmware.vmc.orgs_client":{AccountLink:[2,1,1,""],Providers:[2,1,1,""],Reservations:[2,1,1,""],SddcTemplates:[2,1,1,""],Sddcs:[2,1,1,""],StubFactory:[2,1,1,""],Subscriptions:[2,1,1,""],Tasks:[2,1,1,""]},"com.vmware.vmc.orgs_client.AccountLink":{get:[2,3,1,""]},"com.vmware.vmc.orgs_client.Providers":{list:[2,3,1,""]},"com.vmware.vmc.orgs_client.Reservations":{list:[2,3,1,""]},"com.vmware.vmc.orgs_client.SddcTemplates":{"delete":[2,3,1,""],get:[2,3,1,""],list:[2,3,1,""]},"com.vmware.vmc.orgs_client.Sddcs":{"delete":[2,3,1,""],create:[2,3,1,""],get:[2,3,1,""],list:[2,3,1,""],patch:[2,3,1,""]},"com.vmware.vmc.orgs_client.Subscriptions":{GET_0_OFFER_TYPE_ON_DEMAND:[2,2,1,""],GET_0_OFFER_TYPE_TERM:[2,2,1,""],create:[2,3,1,""],get:[2,3,1,""],get_0:[2,3,1,""]},"com.vmware.vmc.orgs_client.Tasks":{get:[2,3,1,""],list:[2,3,1,""],update:[2,3,1,""]},"com.vmware.vmc_client":{Locale:[1,1,1,""],Orgs:[1,1,1,""],StubFactory:[1,1,1,""]},"com.vmware.vmc_client.Locale":{set:[1,3,1,""]},"com.vmware.vmc_client.Orgs":{get:[1,3,1,""],list:[1,3,1,""]},"vmware.vapi":{vmc:[16,0,0,"-"]},"vmware.vapi.vmc":{client:[16,0,0,"-"],csp_filter:[16,0,0,"-"]},"vmware.vapi.vmc.client":{VmcClient:[16,1,1,""],create_vmc_client:[16,4,1,""]},"vmware.vapi.vmc.csp_filter":{CSPSecurityContextFilter:[16,1,1,""]},"vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter":{get_max_retries:[16,3,1,""],get_security_context:[16,3,1,""],should_retry:[16,3,1,""]},com:{vmware:[1,0,0,"-"]},vmware:{vapi:[15,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:function"},terms:{"00z":2,"09t13":2,"278710ff4e":2,"3de":2,"4d4e":2,"6b6d":2,"boolean":2,"byte":2,"case":[2,16],"class":[1,2,3,4,5,6,7,8,9,10,11,12,16],"default":[2,3,4,5,7,11],"enum":[2,12],"final":2,"float":2,"import":12,"int":16,"long":[2,3,4,7,8,10,11],"new":[2,3,4,12,16],"null":2,"public":[2,3,4,16],"return":[1,2,3,4,5,6,7,8,9,11,16],"switch":2,"true":[2,3,4,5,7,16],"try":3,"while":2,AES:2,AWS:[2,3],DNS:[2,4,7],Dns:[2,4],EBS:[2,3],For:[2,3],IDs:2,IPs:[2,3],NOT:2,Not:[2,4,5,6,7,8,9,10,11],RTS:2,The:[1,2,3,4,5,12],These:2,Used:2,Using:2,VMs:[2,3,4],abandon:2,about:[3,4],abstractent:2,accept:2,access:[2,3,16],access_permiss:2,accompani:3,account:[2,3],account_link_cli:[0,1,2,13],account_link_config:2,account_link_sddc_config:2,account_link_st:2,account_link_state_delai:2,account_link_state_link:2,account_link_state_unlink:2,account_numb:2,accountlink:2,accountlinkconfig:2,accountlinksddcconfig:2,across:3,act:2,action:[2,3,4],action_allow:2,action_deni:2,action_dnat:2,action_snat:2,activ:[2,3],active_cli:2,active_directori:2,active_vse_ha_index:2,add:[2,3,4,8,10,16],added:[2,16],adding_host:2,addit:2,addon:[2,4],addon_typ:4,addons_cli:[0,1,2,3,13],addontyp:4,address:[2,3,4],address_group:2,addressfwsourcedestin:2,addtoal:3,administr:2,advanc:2,advisori:2,aefb:2,aes256:2,aes:2,aes_gcm:2,after:16,against:2,agent:2,agent_st:2,agent_state_custom:2,agent_state_delet:2,agent_state_deploi:2,agent_state_fail:2,agent_state_not_readi:2,agent_state_readi:2,agent_url:2,aggreg:5,aid:2,alert:2,algorithm:2,all:[1,2,3,4,5,7,16],alloc:[2,3],allocation_id:2,allow:[2,3,12,16],allowed_act:2,also:2,alwai:2,amazon_resource_nam:2,ami:2,ami_info:2,amiinfo:2,among:2,amount:2,ani:[2,3],anniversary_billing_d:2,anoth:2,answer:2,api:[2,3,12,16],api_association_id:2,api_subnet_id:2,api_vers:2,apicli:16,append:[8,10],appli:2,applianc:2,appliance_s:2,appliances_summari:2,appliancessummari:2,applic:2,application_id:2,arbitrari:2,argument:2,arn:2,arp:2,arrai:2,ascend:4,assign:2,associ:[2,4],associated_private_ip:[2,3],association_id:2,assoic:4,attach:[2,3],attack:2,attch:3,attribut:[2,12],attrit:12,auth_failur:2,authent:2,authentication_algorithm:2,authentication_mod:2,authentication_psk:2,authentication_unknown:2,author:[1,4,5,6,7,8,9,10,11],auto_renewed_allow:2,automat:16,avail:[2,3,4,5],availability_zon:2,average_bandwidth:2,avoid:2,awar:2,aws_kms_info:2,aws_subnet:3,awsag:2,awscloudprovid:2,awscompatiblesubnet:[2,3],awscustomerconnectedaccount:[2,3],awsesxhost:2,awskeypair:2,awskmsinfo:2,awssddcconfig:2,awssddcconnect:[2,3],awssddcresourceconfig:2,awssubnet:[2,3],back:[2,3,12],backup_restore_bucket:2,backward:2,bad:[2,3,4,5,6,7,8,9,10,11],balanc:2,base:[1,2,3,4,5,6,7,8,9,10,11,12,16],been:[2,3],befor:[2,3],behaviour:3,being:2,belong:2,between:2,bewar:2,billing_subscription_id:2,binari:2,bind:[1,2,3,4,5,6,7,8,9,10,11,12,16],binding_st:2,blank:2,block:2,bodi:[2,4],bogu:2,bool:[2,3,4,5,6,7,16],both:12,bound:3,bre:2,brf:2,bridg:2,broken:2,bucket:2,build:2,bundl:2,burst_siz:2,byte_count:2,c41:2,ca637f38609:2,ca_certif:2,cacertif:2,cach:2,cache_s:2,cached_dbrr_set:2,call:[1,3,16],can:[2,3,11,12],cancel:2,cannot:[2,3],capabl:2,capac:2,care:3,carri:2,cbmstatist:[2,7,11],cbmstatsdata:2,cento:2,centric:2,cert_en:2,certif:2,cf_stack_nam:2,cgw:[0,1,2,3,4,5],cgw_id:2,cgw_name:2,cgw_present:2,chain:16,chanc:2,chang:2,channel:2,channel_st:2,channel_statu:2,channel_status_connect:2,channel_status_disconnect:2,channel_status_unknown:2,charact:2,characterist:2,check:2,choic:2,chosen:3,cidr:2,cidr_block:2,cidr_block_subnet:2,cidr_block_vpc:2,cipher:2,client:[2,13,14,15],client_handl:2,client_hostnam:2,cln:2,close:2,cloud:[2,3],cloud_password:2,cloud_user_group:2,cloud_usernam:2,cloudprovid:2,cltt:2,cluster:[2,3],cluster_config:3,cluster_id:2,cluster_nam:2,cluster_st:2,cluster_state_adding_host:2,cluster_state_deploi:2,cluster_state_fail:2,cluster_state_readi:2,clusterconfig:[2,3],clusterconstraint:3,code:2,collect:2,column:4,com:[12,13],comma:2,commit:2,commitment_term:2,commitment_term_uom:2,common:2,commun:[2,12],communication_channel:2,compat:[2,3],compatiblesubnet:3,compatiblesubnetsasync:3,complet:[2,3],compon:2,compos:2,comput:[2,4,5,6,7,8,9,10,11],compute_gateway_templ:2,computegatewaytempl:2,concurr:2,concurrentchang:[3,4],config:[1,2,3,4,5,6,7,8,9,10,11],config_cli:[0,1,2,3,4,5,7],configur:[1,2,3,4,5,6,7,8,9,10,11],configuration_limit:2,conflict:3,connect:[2,3,4],connected_account_id:2,connectedaccount:3,connection_count:2,connection_ord:2,connectivityagentvalid:2,connectivitytest:4,connectivityvalidationgroup:[2,4],connectivityvalidationgroupresultwrapp:4,connectivityvalidationinput:2,connectivityvalidationsubgroup:2,connector:16,consecut:2,consid:2,constraint:3,consum:2,contain:[2,12],content:13,context:16,control:2,convei:2,convert:3,core:[2,16],correl:2,correlation_id:2,correspond:2,count:2,countri:2,cpu:2,creat:[1,2,3,4,5,6,7,8,9,10,11,12,16],create_addon_type_hcx:4,create_tim:2,create_vmc_cli:16,created_at:2,created_bi:3,createspec:12,creation:[2,4],credenti:[1,2,4],critic:2,crl:2,crl_certif:2,crlcertif:2,cross:2,csp:16,csp_filter:[13,14,15],csp_subscription_id:2,csp_url:16,cspsecuritycontextfilt:16,curl:2,currenc:2,current:[2,3,4,12],custom:[2,3],custom_properti:2,customer_available_zon:2,customer_eni_info:2,customer_subnet_id:2,customereniinfo:2,cycl:2,cycle_id:2,dashboard:[2,11],dashboard_cli:[0,1,2,3,4,5,7],dashboarddata:2,dashboardstat:2,dashboardstatist:[2,11],data:[2,3,7,16],data_dto:2,data_permiss:2,data_store_moid_of_active_vs:2,data_store_name_of_active_vs:2,databas:5,datacent:[2,3],datacenter_moid:2,datacenter_nam:2,datapageedgesummari:2,datapagesddcnetwork:[2,4],datapermiss:2,datastor:2,date:2,datetim:2,day_of_week:2,day_of_week_fridai:2,day_of_week_mondai:2,day_of_week_saturdai:2,day_of_week_sundai:2,day_of_week_thursdai:2,day_of_week_tuesdai:2,day_of_week_wednesdai:2,ddthh:2,debug:2,decryption_failur:2,default_messag:2,default_polici:2,default_route_t:2,default_subnet_rout:2,defin:[2,12],definit:[2,3],delai:2,delay_account_link:2,delet:[2,3,4,6,7,8,10],deletion_fail:2,delimit:2,demand:2,deni:2,denot:2,deploi:2,deploy:2,deploy_appli:2,deployment_typ:2,deployment_type_multi_az:2,deployment_type_multiaz:2,deployment_type_single_az:2,deployment_type_singleaz:2,deprec:[2,3],deprecart:2,deriv:2,describ:2,descript:[2,4,12],destin:2,destination_scop:2,detach:3,detail:[1,2,4,5],detect:2,determin:2,dh14:2,dh15:2,dh16:2,dh2:2,dh5:2,dh_group:2,dh_group_dh14:2,dh_group_dh15:2,dh_group_dh16:2,dh_group_dh2:2,dh_group_dh5:2,dh_group_unknown:2,dhcp:[2,7],dhcp_client:[0,1,2,3,4,5],dhcp_config:2,dhcp_enabl:2,dhcp_ip_rang:2,dhcpleas:[2,7],dhcpleaseinfo:2,dict:[2,3],differ:2,diffi:2,digest_algorithm:2,digest_algorithm_sha1:2,digest_algorithm_sha_256:2,direct:2,disabl:[2,7],disable_ev:2,disconnect:2,discrimin:2,diskgroup:3,displai:2,display_nam:2,distinct:2,distribut:2,distributedportgroup:2,distributedrout:[2,4],distributedvirtualswitch:2,div:2,divid:2,dnat:2,dnat_match_source_address:2,dnat_match_source_port:2,dnat_rule_id:2,dns:2,dns_client:[0,1,2,3,5,13],dns_config:7,dns_server:2,dns_view:2,dns_with_management_vm_private_ip:2,dnsconfig:[2,7],dnsforward:2,dnslisten:2,dnsresponsestat:2,dnsstatusandstat:[2,7],dnsview:2,dnsviewmatch:2,docker:2,document:3,doe:[2,3,12],doesn:[1,2],domain:2,domain_nam:2,done:2,doubl:2,down:2,draa:2,draas_onprem_psc:2,draas_onprem_srm:2,draas_onprem_vcent:2,draas_onprem_vr:2,drop:2,drop_icmp_replai:2,drop_invalid_traff:2,dropped_rx_packet:2,dropped_tx_packet:2,dto:7,durat:2,duration_hour:2,duration_min:2,dvportgroup:2,dynamicstructur:5,each:2,edg:[0,1,2,3,4,5,6],edge_assist_id:2,edge_assist_instance_nam:2,edge_association_id:2,edge_id:[2,5,6,7,8,9,10,11],edge_pag:2,edge_statu:2,edge_subnet_id:2,edge_typ:[2,4],edge_vm_ha_index:2,edge_vm_statu:2,edgejob:2,edges_cli:[0,1,2,3,4],edgestatu:[2,5],edgesummari:2,edgevmstatu:2,edgevnicaddressgroup:2,egress:2,either:[2,16],els:[2,12,16],emerg:2,empti:2,enabl:[2,7],enable_bridge_mod:2,enable_fip:2,enable_nsx_advanced_addon:2,enable_pf:2,enable_proxy_arp:2,enable_send_redirect:2,enable_syn_flood_protect:2,enablefip:4,enclos:2,encript:2,encrypt:2,encryption_a:2,encryption_aes256:2,encryption_aes_gcm:2,encryption_algorithm:2,encryption_failur:2,encryption_triple_d:2,encryption_unknown:2,end:[2,7,11],end_dat:2,end_resource_entity_vers:2,end_tim:[2,7,11],endpoint:2,endswith:2,english:2,eni:2,eni_group:2,eni_id:2,eni_info:2,eniinfo:2,ensur:2,entir:2,entiti:[2,12],entity_metadata:12,entri:2,enumer:2,epoch:[7,11],error:[2,3,16],error_cod:2,error_messag:2,error_valu:16,errorrespons:2,errors_cli:[1,2,3,4,5,6,7,8,9,10,11],errorvalu:16,escap:2,establish:2,established_d:2,estim:2,estimated_remaining_minut:2,esx:[2,3],esx_ami:2,esx_cluster_id:2,esx_config:3,esx_host:2,esx_host_list:2,esx_host_subnet:2,esx_id:2,esx_nsxt_ami:2,esx_security_group_id:2,esx_stat:2,esx_state_delet:2,esx_state_deploi:2,esx_state_fail:2,esx_state_provis:2,esx_state_readi:2,esxconfig:[2,3],esxhost:2,etc:2,even:3,event:2,exampl:[2,3,5],exchang:16,exclud:2,execut:[2,16],exist:[1,2,3,4],exit:3,expir:2,expiration_d:2,explain:12,express:2,extend:2,extended_attribut:2,extendedattribut:2,extens:2,extern:2,extra:2,factor:2,factori:16,fail:2,failur:2,failure_messag:2,fals:[2,5,7,16],featur:[2,3,5],feature_cap:2,feature_status:2,feature_typ:2,featurecap:2,featurestatu:2,fence_paramet:2,fetch:4,field:2,file:12,filepath:12,filter:[2,3,4,16],find:[2,3,4],finish:[2,3],fip:2,firewal:[0,1,2,3,4,5,7,11],firewall_cli:[0,1,2,3,4,5],firewall_config:7,firewall_rul:[2,8],firewallconfig:[2,7],firewalldashboardstat:2,firewalldefaultpolici:2,firewallglobalconfig:2,firewallrul:[2,8],firewallrulescop:2,firewallrulestat:[2,7],firewallservic:2,first:[2,12],flag:2,flavor:3,flood:2,fm_log_collector:2,fm_metrics_collector:2,folder:12,follow:[2,12],forbidden:[1,2,3,4,5,6,7,8,9,10,11],forc:[2,3],force_even_when_sddc_pres:3,force_refresh:3,forcefulli:2,forcibl:3,form:[2,5],form_err:2,format:[2,5],forward:2,forward_proxi:2,found:[2,3,4,5,6,7,8,9,10,11],four:3,fqdn:[2,4],free:[3,5],fridai:2,from:[2,3,5,7,11,12,16],futur:12,gatewai:[2,4,5,6,7,8,9,10,11],gateway_ip:2,gatewayservic:[2,4],gatewaytempl:2,gcm:2,gener:[2,3,5,12],get:[1,2,3,4,5,6,7,8,9,11,12,16],get_0:[2,4],get_0_offer_type_on_demand:2,get_0_offer_type_term:2,get_addon_type_hcx:4,get_max_retri:16,get_security_context:16,getlatest:5,gib:2,given:[2,3,11],glcm:2,glcm_bundl:2,glcmbundl:2,global:2,global_:2,global_config:2,green:2,grei:2,group:2,grouping_object_id:2,groupingobject:2,ha_stat:2,ha_vnic_in_us:2,happen:2,hardwar:2,hardware_typ:2,has:[2,3,12],have:[2,3,12],hcx:4,header:[4,5,6,7,8,9,10,11],health:2,healthcheck:2,hellman:2,help:2,helper:16,high:[2,3],hlm:2,holder:2,host:[2,3],host_cpu_cores_count:2,host_ip:2,host_lease_info_dto:2,host_lease_infos_dto:2,host_moid_of_active_vs:2,host_name_of_active_vs:2,hostleaseinfo:2,hostnam:2,hostname_or_ip:2,hostname_verifier_en:2,hour_of_dai:2,how:12,http:[2,16],hypervisor_assist:2,icmp6:2,icmp6_timeout:2,icmp:2,icmp_timeout:2,icmp_typ:2,icmptyp:2,id_active_directori:2,id_draa:2,id_draas_onprem_psc:2,id_draas_onprem_srm:2,id_draas_onprem_vcent:2,id_draas_onprem_vr:2,id_hlm:2,id_host_ip:2,id_hostnam:2,id_hostname_or_ip:2,id_onprem_esx:2,id_onprem_psc:2,id_onprem_vcent:2,id_primary_dn:2,id_secondary_dn:2,idempot:2,identifi:[1,2,3,4,5,6,7,8,9,10,11],ignor:2,ike_opt:2,ike_option_ikev1:2,ike_option_ikev2:2,ike_statu:2,ikev1:2,ikev2:2,implement:2,in_:2,in_maintenance_mod:2,in_maintenance_window:2,in_shaping_polici:2,includ:[2,12],increment:2,index:[2,4,13],indic:2,individu:2,info:2,inform:[2,3,4],inherit:2,initi:[1,2,3,4,5,6,7,8,9,10,11,16],input:[2,4,5],instal:2,instanc:[1,2,3,4,5,6,7,8,9,10,11,12,16],instance_id:2,instance_typ:3,instanti:[2,12],instead:2,int32:2,int64:2,integrity_error:2,intend:2,interactionpermiss:2,interfac:[2,5,7,11],interfaces_cli:[0,1,2,3,4,5,7],interfacesdashboardstat:2,intermitt:2,intern:[2,3,11],internal_high:2,internal_ip:2,internal_network_id:2,internal_port:2,internal_public_ip_pool:2,internalservererror:[2,3],internet:2,internet_gateway_id:2,interv:[2,11],inus:2,invalid:[2,3,4,5,6,7,8,9,10,11],invalid_appl:2,invalid_destin:2,invalid_sourc:2,invalidrequest:[2,3,4,5,6,7,8,9,10,11],involv:2,ip1:2,ip_address:2,ip_generic_timeout:2,ip_pool:2,ip_rang:2,ip_set:2,ip_typ:4,ipaddress:2,ipn:2,ipsec:[2,5,7,11],ipsec_bytes_in:2,ipsec_bytes_out:2,ipsec_cli:[0,1,2,3,4,5],ipsec_tunnel:2,ipsecdashboardstat:2,ipsecglobalconfig:2,ipsecsit:[2,5],ipsecsiteconfig:5,ipsecsiteikestatu:2,ipsecsitestat:2,ipsecstatusandstat:[2,7],ipsectunnelstat:2,ipset:2,iptyp:4,ipv4:2,is_compat:2,is_connect:2,is_licens:2,is_mast:2,is_support:2,is_univers:2,is_upgrade_avail:2,isconnect:2,iso:2,its:2,job:2,job_id:2,jre:2,json:[5,12],just:2,kbp:2,keep:2,kei:2,key_fingerprint:2,key_materi:2,key_nam:2,key_pair:2,keyvalueattribut:2,kilobit:2,kms_vpc_endpoint:2,kmsvpcendpoint:2,l2_extens:2,l2_vpn:2,l2extens:2,l2vpn:[0,1,2,3,4,5,7],l2vpn_client:[0,1,2,3,4,5],l2vpnstat:2,l2vpnstatusandstat:[2,9],label:2,lan:2,languag:2,last:2,last_info_messag:2,last_informational_messag:2,last_published_pre_rules_generation_numb:2,last_updated_tim:2,later:2,latest:[2,5],layer:2,lb_bps_in:2,lb_bps_out:2,lb_http_req:2,lb_session:2,ld_rname:4,lead:3,leas:2,leaseinfo:7,least:2,left:2,legacyportgroup:2,length:2,letter:2,level:2,licenc:2,licenceaclpermiss:2,lif:2,limit:2,link:[2,3],linkag:2,linked_account_id:3,linked_account_path_id:3,list:[1,2,3,4],list_addon_type_hcx:4,listen:2,listener_ip:2,liter:2,live:5,load:2,load_balanc:2,loadbalancerdashboardstat:2,local:[1,2],local_egress_en:2,local_id:2,local_ip:2,local_ip_address:2,local_spi:2,local_subnet:2,localip:2,localized_error_messag:2,localized_messag:2,locat:2,log:2,log_icmp_error:2,log_invalid_traff:2,log_level:2,logging_en:2,logic:[2,4],logical_network:2,logical_router_scop:2,logical_switch_id:2,logical_switch_nam:2,logicalnetwork:2,logicalrouterscop:2,logicalswitch:2,logz_log_collector:2,loss:3,lower:2,lrouter_uuid:2,mac:2,mac_address:2,macaddress:2,machin:2,mai:[2,12],mainent:2,mainten:[2,3],maintenance_properti:2,maintenancewindow:[2,3],maintenancewindowentri:2,maintenancewindowget:[2,3],make:[2,16],manag:[2,4,5,7,8,10,11],manage_permiss:2,managedobjectrefer:2,management_d:2,management_gateway_templ:2,management_rp:2,management_vm_id:4,management_vms_cli:[0,1,2,3,13],managementgatewaytempl:2,mandatori:3,manifest:2,manifest_id:2,map:[2,3],map_zones_request:3,mapcustomerzon:3,mapzonesrequest:[2,3],mark:2,mask:2,master:2,match:[2,4],match_transl:2,max:[2,16],max_capac:2,max_num_public_ip:2,maximum:2,mean:2,meaning:2,measur:2,member:3,messag:2,meta_dto:2,metadashboardstat:2,metadata:[2,4,12],metadata_cli:12,metal:3,method:[2,3,4,12,16],mgmt_appliance_network_nam:2,mgw:2,mgw_id:2,might:2,millisecond:[7,11],min:[2,11],min_capac:2,minimum:[2,3],minimum_seats_avail:3,minu:2,minut:2,miss:3,mix:2,mod:2,mode:2,model:[1,2,3,4,5,6,7,8,9,11],model_cli:[0,1,3,4,5,6,7,8,9,10,11,13],modif:2,modifi:[2,4,6,7,8],modul:[0,12,13,14,15],moid:2,mondai:2,monitor:2,monthly_cost:2,more:[2,3],most:2,mostli:2,move:[2,3],mtu:2,mul:2,multi:2,multi_az:2,multiaz:2,multipl:2,must:[2,3],name:[2,3,4,12],nat:[0,1,2,3,4,5,7],nat_client:[0,1,2,3,4,5],nat_rul:[2,10],nat_rules_dto:2,natrul:[2,10],need:[2,3],nest:2,netmask:2,network:[0,1,2,3,4],network_gatewai:2,network_id:4,network_interface_id:2,network_netmask:2,network_templ:2,network_typ:2,network_type_extend:2,network_type_host:2,network_type_rout:2,networking_cli:[0,1,2,3,13],networks_cli:[0,1,2,3,13],networktempl:2,newcredenti:[2,4],newer:[2,12],next_binding_st:2,nic:2,node:[2,3],node_id:2,non:3,none:[2,3,4,5,6,7,11,16],not_readi:2,note:2,notfound:[1,2,3,4,5,6,7,8,9,10,11],notic:2,notifi:3,nsx:[2,4,5,7,8,9,10,11],nsx_api_public_endpoint_url:2,nsx_controller_ip:2,nsx_mgr_management_ip:2,nsx_mgr_url:2,nsxfirewallrul:[2,8],nsxfirewallservic:2,nsxl2vpn:[2,6],nsxnatrul:[2,10],nsxsite:2,nsxt:2,nsxt_addon:2,nsxtaddon:2,ntp:2,num_host:[2,3],number:[2,3,4,16],number_of_connected_vn:2,number_of_deployed_vm:2,nx_domain:2,nxrrset:2,object:[3,4,5,6,7,8,9,10,11,16],object_id:2,object_type_nam:2,objectid:5,objecttyp:[2,5],obtain:16,occur:16,off:3,offer:[2,3],offer_context_id:2,offer_nam:2,offer_typ:2,offer_vers:2,offerinst:3,offerinstanceshold:[2,3],offertyp:2,old:2,older:12,omit:2,on_demand:2,on_error:16,on_prem_gateway_ip:2,on_prem_nat_ip:2,on_prem_network_cidr:2,on_prem_subnet:2,onc:2,ondemandofferinst:2,one:[2,3,4,12,16],onedai:11,onemonth:11,oneweek:11,oneyear:11,ongo:2,onli:[2,12],onprem_esx:2,onprem_psc:2,onprem_vcent:2,ons:2,open:2,oper:[2,3],option:[2,3,4,5,6,7,11],order:[2,4],order_submit:2,org:[0,1,2,13],org_id:2,org_typ:2,organ:[1,2,3,4,5,6,7,8,9,10,11],orgid:2,orgproperti:2,orgs_client:[0,1,13],origin:2,original_address:2,original_port:2,original_servic:2,original_service_error_cod:2,other:[2,4],out:2,out_shaping_polici:2,output:5,over:2,overal:2,overwrit:2,packag:13,packet:2,packet_count:2,packet_received_error:2,packet_sent_error:2,packets_in:2,packets_out:2,page:[2,4,12,13],page_s:[2,4],pagededgelist:[2,4],pagin:4,paging_info:2,paginginfo:2,pair:2,param:[2,3,4],paramet:[1,2,3,4,5,6,7,8,9,10,11,12,16],parent_task_id:2,partially_connect:2,particular:3,partner:2,pass:[2,3,4,5,6,7,8,9,10,11,12,16],password:2,patch:2,path:2,pattern:2,payload:[3,4],peak_bandwidth:2,peer:[2,5],peer_id:2,peer_ip:2,peer_ip_address:2,peer_spi:2,peer_subnet:2,peerconfig:5,peering_connection_id:2,peerip:2,pending_provis:2,per:[2,4,5],percentag:2,perfect:2,perform:2,permiss:2,persist:2,perspect:2,petrona:2,petronas_regions_to_map:2,pfs_enabl:2,phase:2,phase_in_progress:2,physic:2,pick:2,ping:2,pipelin:2,platform:2,pleas:[2,3],plu:2,polici:2,policy_external_id:2,policy_payer_arn:2,policy_payer_linked_arn:2,policy_service_arn:2,pool:2,pop:2,pop_agent_xeni_connect:2,pop_info:2,popagentxeniconnect:2,popamiinfo:2,popinfo:2,popserviceinfo:2,port:2,portgroup:2,portgroup_id:2,portgroup_nam:2,possibl:[2,4],post:[3,4],power:3,pre:2,pre_rules_exist:2,pre_rules_generation_numb:2,pre_shared_kei:2,predefin:2,prefer:2,prefix:2,prefix_length:2,prem:2,present:2,prev_edge_id:4,prev_sddc_network_id:4,prevedgeid:4,previou:4,price:2,primari:2,primary_address:2,primary_dn:2,primary_ip_address:2,print:12,privat:[2,3,4],private_ip:2,private_subnet_id:2,privileg:[2,3],problem:2,process:[2,3],product:[2,3],product_charge_id:2,product_id:2,product_typ:[2,3],program:12,progress:2,progress_perc:2,project_st:2,project_state_cr:2,project_state_delet:2,properti:2,protect:2,protocol:2,provid:[2,3,4,5,6,7,8,9,10,11,12,16],provider_aw:2,providess:16,provis:2,proxi:2,psc:2,psc_management_ip:2,psc_url:2,psk:2,public_ip:2,public_ip_pool:2,public_port:2,publicip:3,publish:2,publish_permiss:2,publish_statu:2,purchas:[2,3],put:3,quantiti:2,queri:[2,3],quot:2,rais:[1,2,3,4,5,6,7,8,9,10,11],rang:2,rate:2,read:2,readi:2,reason:2,reattach:3,receiv:[2,12],recent:2,recent_job_info:2,recommended_capac:2,record:[2,4],recurs:2,red:2,redirect:2,redund:3,ref:3,refer:[2,4],refresh:[3,16],refresh_token:16,refresh_url:16,region:[2,3],region_nam:2,region_to_az_to_shadow_map:2,regist:2,reject:2,relat:2,remain:2,remap:2,remot:12,remov:[2,3],removefromal:3,renam:3,repeat:2,replai:2,replay_error:2,repres:[2,12],request:[2,3,4,5,6,7,8,9,10,11,16],request_info:4,requir:[1,2,3,4,5,6,7,8,9,10,11],reserv:[2,3],reservation_id:2,reservation_schedul:2,reservation_st:2,reservation_state_cancel:2,reservation_state_complet:2,reservation_state_run:2,reservation_state_schedul:2,reservationinmw:2,reservations_cli:[0,1,2,13],reservations_mw:2,reservationschedul:2,reservationwindow:[2,3],reservationwindowmaintenanceproperti:2,reserve_id:2,reset:2,resgroup:2,resid:2,resolv:2,resourc:[2,3],resource_config:2,resource_id:2,resource_pool_moid_of_active_vs:2,resource_pool_name_of_active_vs:2,resource_typ:2,resourcepool:2,respond:2,respons:[1,2,5,12],rest:2,restrict:2,result:2,retain:2,retain_configur:2,retainconfigur:2,retreiv:3,retri:[2,16],retriev:[2,4,5,6,7,8,9,11,16],retryabl:2,reverse_proxi:2,revis:2,rid:2,rout:2,route_table_id:2,router:[2,4],rule:[2,7,8,10],rule_id:[2,7,8,10],rule_interfac:2,rule_tag:2,rule_typ:2,rule_type_default:2,rule_type_us:2,ruleid:2,run:2,rx_bytes_on_local_subnet:2,rx_bytes_on_sit:2,s3_adapt:2,s3_bucket:2,same:[2,4],saturdai:2,save_permiss:2,schedul:2,scope:[2,4],scopeinfo:2,sddc:[0,1,2,3,13],sddc_access_st:2,sddc_config:2,sddc_id:[2,3,4],sddc_manifest:2,sddc_network:[2,4],sddc_patch_request:2,sddc_public_ip_object:3,sddc_state:[2,3],sddc_state_delet:2,sddc_state_deletion_fail:2,sddc_state_deploi:2,sddc_state_fail:2,sddc_state_readi:2,sddc_template_id:2,sddc_type:2,sddcallocatepublicipspec:[2,3],sddcconfig:2,sddcconnect:3,sddcid:[2,3],sddclinkconfig:2,sddcmanifest:2,sddcnetwork:[2,4],sddcnetworkaddressgroup:2,sddcnetworkdhcpconfig:2,sddcnetworkdhcpippool:2,sddcpatchrequest:2,sddcpublicip:[2,3],sddcresourceconfig:2,sddcs_client:[0,1,2,13],sddcstaterequest:[2,3],sddctemplat:[2,3],sdk:12,search:13,seat:[2,3],second:2,secondari:2,secondary_address:2,secondary_dn:2,secondary_ip_address:2,secondaryaddress:2,secreci:2,secur:[2,16],secure_traff:2,security_context_filt:16,security_group_id:2,securitycontext:16,securitycontextfilt:16,securitygroup:2,see:[2,12],select:2,send:[2,12],sensit:7,sent:2,separ:2,seper:2,sequence_number_over_flow_error:2,serv:[2,4],server:[2,3,7,12],server_fail:2,server_statu:2,servic:[2,12,16],service_ag:2,service_aid:2,service_br:2,service_brf:2,service_certif:2,service_dn:2,service_dock:2,service_error:2,service_fm_log_collector:2,service_fm_metrics_collector:2,service_forward_proxi:2,service_glcm:2,service_info:2,service_jr:2,service_logz_log_collector:2,service_ntp:2,service_o:2,service_reverse_proxi:2,service_rt:2,service_s3_adapt:2,serviceerror:2,servicegroup:2,session:[1,2,16],sessions_cr:2,set:[1,2,3,4,7],setup:3,sha1:2,sha_256:2,shadow:2,share:2,should:[2,3,16],should_retri:16,show:[7,11],show_sensitive_data:[6,7],sign:2,sinc:[7,11,12],singl:[2,3],single_az:2,singleaz:2,site:[2,5],site_id:2,site_stat:2,site_statist:2,site_statu:2,size:[2,3,4],skip:2,skip_creating_vxlan:2,skyscrap:2,snat:2,snat_match_destination_address:2,snat_match_destination_port:2,snat_rule_id:2,softwar:2,some:2,sort:4,sort_bi:[2,4],sort_order_ascend:[2,4],sourc:[2,12],source_info:12,source_port:2,source_scop:2,source_sddc_id:2,source_srm:2,source_svc:12,source_vcent:2,source_vr:2,sourcetyp:12,space:2,spec:[3,12],special:[2,12],specif:[2,3,7,8,10],specifi:[2,3,4,5,7,8,12,16],srm:2,ssl:2,sslvpn:2,sslvpn_bytes_in:2,sslvpn_bytes_out:2,sslvpndashboardstat:2,sso:2,sso_domain:2,sss:2,stamp:2,standard:2,standbi:2,start:[2,4,7,11],start_dai:2,start_dat:2,start_day_fridai:2,start_day_mondai:2,start_day_saturdai:2,start_day_sundai:2,start_day_thursdai:2,start_day_tuesdai:2,start_day_wednesdai:2,start_hour:2,start_index:[2,4],start_resource_entity_vers:2,start_tim:[2,7,11],startindex:4,startswith:2,state:[2,3,4],state_act:2,state_appli:2,state_avail:2,state_broken:2,state_connect:2,state_delet:2,state_disconnect:2,state_fail:2,state_initi:2,state_inus:2,state_partially_connect:2,state_unknown:2,states_cancel:2,states_complet:2,states_run:2,states_schedul:2,statist:[0,1,2,3,4,5,7,9],statistics_cli:[0,1,2,3,4,5],statu:[2,5],status_activ:2,status_cancel:2,status_cr:2,status_expir:2,status_fail:2,status_finish:2,status_from_vse_updated_on:2,status_order_submit:2,status_pending_provis:2,status_start:2,std:[1,2,3,4,5,6,7,8,9,10,11],still:3,stop:2,storag:[2,3],storage_capac:2,storage_cli:[0,1,2,13],store:2,str:[1,2,3,4,5,6,7,8,9,10,11,12,16],string:[2,3,12],struct:[2,5],stub:[1,2,3,4,5,6,7,8,9,10,11,16],stub_config:[1,2,3,4,5,6,7,8,9,10,11],stubconfigur:[1,2,3,4,5,6,7,8,9,10,11],stubfactori:[1,2,3,4,5,6,7,8,9,10,11],stubfactorybas:[1,2,3,4,5,6,7,8,9,10,11],sub:2,sub_group:2,sub_interfac:2,sub_statu:2,subgroup:2,subinterfac:2,submodul:[0,13,14,15],subnet:[2,3],subnet_availability_zon:2,subnet_cidr:2,subnet_cidr_block:2,subnet_id:2,subnet_list_result:3,subnet_mask:2,subnet_prefix_length:2,subnetinfo:2,subpackag:13,subscript:2,subscription_request:2,subscriptiondetail:2,subscriptionid:2,subscriptionproduct:[2,3],subscriptionrequest:2,subscriptions_cli:[0,1,2,13],subsequ:2,substr:2,success:2,summari:[2,5],sundai:2,suppli:2,support:[2,3,12],support_window_id:2,supported_capacity_incr:2,supportwindow:[2,3],supportwindowid:[2,3],syn:2,sync:2,system:[2,12],system_statu:2,tabl:2,tag:2,take:[2,3],target:[2,3],task:[2,3,4],task_progress_phas:2,task_typ:2,task_vers:2,taskprogressphas:2,tbrs_client:[0,1,2,13],tcp:2,tcp_allow_out_of_window_packet:2,tcp_pick_ongoing_connect:2,tcp_send_reset_for_closed_vse_port:2,tcp_timeout_clos:2,tcp_timeout_establish:2,tcp_timeout_open:2,templat:[2,3,5],template_id:2,template_nam:2,templateid:5,tenant:2,tenant_id:2,tenantid:4,tend:2,term:2,termin:2,termofferinst:2,test:[2,4],test_result:4,text:[2,5],than:2,them:2,thi:[2,3,7,11,12,16],those:2,through:2,thursdai:2,time:[2,7,11],time_stamp:2,timeout:2,timestamp:2,token:16,tolow:2,total:2,total_count:2,toupper:2,tracerout:2,track:2,traffic:2,traffic_stat:2,trafficshapingpolici:2,transact:2,transfer:2,translat:[1,2],translated_address:2,translated_port:2,transmit:2,transportzon:2,triple_d:2,trunk:2,tsfp:2,tstp:2,tuesdai:2,tunnel:2,tunnel_id:2,tunnel_st:2,tunnel_stat:2,tunnel_statu:2,tunnel_status:2,tunnel_status_connect:2,tunnel_status_disconnect:2,tunnel_status_unknown:2,turn:2,two:[2,12],tx_bytes_from_local_subnet:2,tx_bytes_from_sit:2,type:[1,2,3,4,5,6,7,8,9,11,16],type_cento:2,type_connect:2,type_curl:2,type_dn:2,type_p:2,type_pop:2,type_tracerout:2,udlr:2,udp:2,udp_timeout:2,uid:2,unari:2,unauthent:[1,2,3,4,16],unauthor:[1,2,3,4,5,6,7,8,9,10,11,16],undeploi:2,under:3,undergo:2,uniqifi:2,uniqu:2,unit:2,unit_pric:2,univers:2,universal_revis:2,unknown:[2,12],unlink:2,until:[2,7,11],updat:[2,3,4,6,7,8,10],update_addon_type_hcx:4,update_ip_type_priv:4,update_ip_type_publ:4,updatecredenti:[2,4],updated_by_user_id:2,updated_by_user_nam:2,upgrad:[2,3],uplink:[2,11],upon:2,upper:2,uri:2,url:[2,16],use:[2,3,4,12,16],used:[1,2,3,4,5,6,7,8,9,10,11,16],user:[1,2,3],user_id:2,user_nam:2,usernam:2,using:[2,4,16],usual:2,utc:2,uuid:2,valid:[2,3,4,5],valu:[2,3,4,5,7,12,16],vapi:[1,2,3,4,5,6,7,8,9,10,11,12,13,14],vapiinterfac:[1,2,3,4,5,6,7,8,9,10,11],vapistruct:[2,5],vapp:2,variabl:12,vc_instance_id:2,vc_management_ip:2,vc_public_ip:2,vc_url:2,vcenter:[2,3],version:[2,12],vgw:2,vgw_route_table_id:2,via:3,view:2,view_id:2,view_match:2,view_permiss:2,vif_id:2,virtual:2,virtualmachin:2,virtualwir:2,vlan:2,vlan_id:2,vm_build_info:2,vm_moid_of_active_vs:2,vm_name_of_active_vs:2,vm_security_group_id:2,vm_version:2,vmc:[0,1,13,14,15],vmc_client:[0,13],vmc_internal_vers:2,vmc_local:1,vmc_url:16,vmc_version:2,vmcclient:16,vmcinternalvers:2,vmclocal:[1,2],vmcversion:2,vmware:[0,12],vnic0:2,vnic0_in_byt:2,vnic0_in_pkt:2,vnic0_out_byt:2,vnic0_out_pkt:2,vnic1:2,vnic1_in_byt:2,vnic1_in_pkt:2,vnic1_out_byt:2,vnic1_out_pkt:2,vnic2:2,vnic2_in_byt:2,vnic2_in_pkt:2,vnic2_out_byt:2,vnic2_out_pkt:2,vnic3:2,vnic3_in_byt:2,vnic3_in_pkt:2,vnic3_out_byt:2,vnic3_out_pkt:2,vnic4:2,vnic4_in_byt:2,vnic4_in_pkt:2,vnic4_out_byt:2,vnic4_out_pkt:2,vnic5:2,vnic5_in_byt:2,vnic5_in_pkt:2,vnic5_out_byt:2,vnic5_out_pkt:2,vnic6:2,vnic6_in_byt:2,vnic6_in_pkt:2,vnic6_out_byt:2,vnic6_out_pkt:2,vnic7:2,vnic7_in_byt:2,vnic7_in_pkt:2,vnic7_out_byt:2,vnic7_out_pkt:2,vnic8:2,vnic8_in_byt:2,vnic8_in_pkt:2,vnic8_out_byt:2,vnic8_out_pkt:2,vnic9:2,vnic9_in_byt:2,vnic9_in_pkt:2,vnic9_out_byt:2,vnic9_out_pkt:2,vnic:[2,5],vnic_:2,vnic_group_id:2,vnic_group_ids_extern:2,vnic_group_ids_intern:2,vnic_group_ids_vnic_index_0:2,vnic_group_ids_vnic_index_1:2,vnic_group_ids_vnic_index_2:2,vnic_group_ids_vnic_index_3:2,vnic_group_ids_vnic_index_4:2,vnic_group_ids_vnic_index_5:2,vnic_group_ids_vnic_index_6:2,vnic_group_ids_vnic_index_7:2,vnic_group_ids_vnic_index_8:2,vnic_group_ids_vnic_index_9:2,vnic_group_ids_vs:2,vnicindex:2,vpc:2,vpc_cidr:2,vpc_cidr_block:2,vpc_endpoint_id:2,vpc_id:2,vpc_info:2,vpc_info_peered_ag:2,vpc_map:2,vpcinfo:2,vpcinfosubnet:2,vpn:[2,5,6,7,9],vpnchannelstatu:2,vpntunnelstatu:2,vpntunneltrafficstat:2,vsan_encryption_config:2,vsanconfigconstraint:[2,3],vsanencryptionconfig:2,vsanstoragedesign:2,vse:2,vsm_uuid:2,vsphere:2,vxlan:2,vxlan_subnet:2,want:[2,12],warn:2,wednesdai:2,week:2,week_of:2,were:2,west:2,what:[2,3],when:[2,3,12],where:2,whether:[2,16],which:[1,2,3,12],white:2,who:3,why:2,win:2,window:[2,3],window_id:2,wire:2,wit:2,within:2,without:2,witness_availability_zon:2,work:[2,3],workflow:2,workload:[2,3],would:[2,12],writer:2,xml:5,yellow:2,yet:2,you:[2,3,12],your:[2,4,12],yyyi:2,zerocloud:3,zone:[2,3]},titles:["com package","com.vmware package","com.vmware.vmc package","com.vmware.vmc.orgs package","com.vmware.vmc.orgs.sddcs package","com.vmware.vmc.orgs.sddcs.networks package","com.vmware.vmc.orgs.sddcs.networks.cgws package","com.vmware.vmc.orgs.sddcs.networks.edges package","com.vmware.vmc.orgs.sddcs.networks.edges.firewall package","com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package","com.vmware.vmc.orgs.sddcs.networks.edges.nat package","com.vmware.vmc.orgs.sddcs.networks.edges.statistics package","Interface definition language to python mapping for enumerated types","Welcome to VMware Cloud on AWS Console API\u2019s documentation!","vmware package","vmware.vapi package","vmware.vapi.vmc package"],titleterms:{AWS:13,account_link_cli:3,addons_cli:4,api:13,cgw:6,client:16,cloud:13,code:12,com:[0,1,2,3,4,5,6,7,8,9,10,11],config_cli:[8,9,10],consol:13,csp_filter:16,dashboard_cli:11,definit:12,dhcp_client:7,dns_client:[4,7],document:[12,13],edg:[7,8,9,10,11],edges_cli:5,enumer:12,exampl:12,firewal:8,firewall_cli:7,indic:13,interfac:12,interfaces_cli:11,ipsec_cli:7,l2vpn:9,l2vpn_client:6,languag:12,management_vms_cli:4,map:12,model_cli:2,modul:[1,2,3,4,5,6,7,8,9,10,11,16],nat:10,nat_client:7,network:[5,6,7,8,9,10,11],networking_cli:4,networks_cli:4,org:[3,4,5,6,7,8,9,10,11],orgs_client:2,packag:[0,1,2,3,4,5,6,7,8,9,10,11,14,15,16],python:12,reservations_cli:3,sddc:[4,5,6,7,8,9,10,11],sddcs_client:3,statist:11,statistics_cli:7,storage_cli:3,submodul:[1,2,3,4,5,6,7,8,9,10,11,16],subpackag:[0,1,2,3,4,5,7,14,15],subscriptions_cli:3,tabl:13,tbrs_client:3,type:12,vapi:[15,16],vmc:[2,3,4,5,6,7,8,9,10,11,16],vmc_client:1,vmware:[1,2,3,4,5,6,7,8,9,10,11,13,14,15,16],welcom:13}}) \ No newline at end of file +Search.setIndex({docnames:["com","com.vmware","com.vmware.vmc","com.vmware.vmc.orgs","com.vmware.vmc.orgs.sddcs","com.vmware.vmc.orgs.sddcs.networks","com.vmware.vmc.orgs.sddcs.networks.cgws","com.vmware.vmc.orgs.sddcs.networks.edges","com.vmware.vmc.orgs.sddcs.networks.edges.firewall","com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn","com.vmware.vmc.orgs.sddcs.networks.edges.nat","com.vmware.vmc.orgs.sddcs.networks.edges.statistics","enumeration","index","vmware","vmware.vapi","vmware.vapi.vmc"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:56},filenames:["com.rst","com.vmware.rst","com.vmware.vmc.rst","com.vmware.vmc.orgs.rst","com.vmware.vmc.orgs.sddcs.rst","com.vmware.vmc.orgs.sddcs.networks.rst","com.vmware.vmc.orgs.sddcs.networks.cgws.rst","com.vmware.vmc.orgs.sddcs.networks.edges.rst","com.vmware.vmc.orgs.sddcs.networks.edges.firewall.rst","com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.rst","com.vmware.vmc.orgs.sddcs.networks.edges.nat.rst","com.vmware.vmc.orgs.sddcs.networks.edges.statistics.rst","enumeration.rst","index.rst","vmware.rst","vmware.vapi.rst","vmware.vapi.vmc.rst"],objects:{"":{com:[0,0,0,"-"],vmware:[14,0,0,"-"]},"com.vmware":{vmc:[2,0,0,"-"],vmc_client:[1,0,0,"-"]},"com.vmware.vmc":{model_client:[2,0,0,"-"],orgs:[3,0,0,"-"],orgs_client:[2,0,0,"-"]},"com.vmware.vmc.model_client":{AbstractEntity:[2,1,1,""],AccountLinkConfig:[2,1,1,""],AccountLinkSddcConfig:[2,1,1,""],AddressFWSourceDestination:[2,1,1,""],Agent:[2,1,1,""],AmiInfo:[2,1,1,""],AppliancesSummary:[2,1,1,""],Application:[2,1,1,""],AwsAgent:[2,1,1,""],AwsCloudProvider:[2,1,1,""],AwsCompatibleSubnets:[2,1,1,""],AwsCustomerConnectedAccount:[2,1,1,""],AwsEsxHost:[2,1,1,""],AwsKeyPair:[2,1,1,""],AwsKmsInfo:[2,1,1,""],AwsSddcConfig:[2,1,1,""],AwsSddcConnection:[2,1,1,""],AwsSddcResourceConfig:[2,1,1,""],AwsSubnet:[2,1,1,""],CaCertificates:[2,1,1,""],CbmStatistic:[2,1,1,""],CbmStatistics:[2,1,1,""],CbmStatsData:[2,1,1,""],CloudProvider:[2,1,1,""],Cluster:[2,1,1,""],ClusterConfig:[2,1,1,""],ComputeGatewayTemplate:[2,1,1,""],ConnectivityAgentValidation:[2,1,1,""],ConnectivityValidationGroup:[2,1,1,""],ConnectivityValidationGroups:[2,1,1,""],ConnectivityValidationInput:[2,1,1,""],ConnectivityValidationSubGroup:[2,1,1,""],CrlCertificates:[2,1,1,""],CustomerEniInfo:[2,1,1,""],DashboardData:[2,1,1,""],DashboardStat:[2,1,1,""],DashboardStatistics:[2,1,1,""],DataPageEdgeSummary:[2,1,1,""],DataPageSddcNetwork:[2,1,1,""],DataPermissions:[2,1,1,""],DhcpLeaseInfo:[2,1,1,""],DhcpLeases:[2,1,1,""],DnsConfig:[2,1,1,""],DnsForwarders:[2,1,1,""],DnsListeners:[2,1,1,""],DnsResponseStats:[2,1,1,""],DnsStatusAndStats:[2,1,1,""],DnsView:[2,1,1,""],DnsViewMatch:[2,1,1,""],DnsViews:[2,1,1,""],EdgeJob:[2,1,1,""],EdgeStatus:[2,1,1,""],EdgeSummary:[2,1,1,""],EdgeVmStatus:[2,1,1,""],EdgeVnicAddressGroup:[2,1,1,""],EdgeVnicAddressGroups:[2,1,1,""],EniInfo:[2,1,1,""],ErrorResponse:[2,1,1,""],EsxConfig:[2,1,1,""],EsxHost:[2,1,1,""],ExtendedAttribute:[2,1,1,""],FeatureCapabilities:[2,1,1,""],FeatureCapability:[2,1,1,""],FeatureStatus:[2,1,1,""],FirewallConfig:[2,1,1,""],FirewallDashboardStats:[2,1,1,""],FirewallDefaultPolicy:[2,1,1,""],FirewallGlobalConfig:[2,1,1,""],FirewallRule:[2,1,1,""],FirewallRuleScope:[2,1,1,""],FirewallRuleStats:[2,1,1,""],FirewallRules:[2,1,1,""],FirewallService:[2,1,1,""],GatewayTemplate:[2,1,1,""],GlcmBundle:[2,1,1,""],HostLeaseInfo:[2,1,1,""],InteractionPermissions:[2,1,1,""],InterfacesDashboardStats:[2,1,1,""],IpAddresses:[2,1,1,""],Ipsec:[2,1,1,""],IpsecDashboardStats:[2,1,1,""],IpsecGlobalConfig:[2,1,1,""],IpsecSite:[2,1,1,""],IpsecSiteIKEStatus:[2,1,1,""],IpsecSiteStats:[2,1,1,""],IpsecSites:[2,1,1,""],IpsecStatusAndStats:[2,1,1,""],IpsecTunnelStats:[2,1,1,""],KeyValueAttributes:[2,1,1,""],KmsVpcEndpoint:[2,1,1,""],L2Extension:[2,1,1,""],L2Vpn:[2,1,1,""],L2vpnStats:[2,1,1,""],L2vpnStatusAndStats:[2,1,1,""],LicenceAclPermissions:[2,1,1,""],LoadBalancerDashboardStats:[2,1,1,""],Logging:[2,1,1,""],LogicalNetwork:[2,1,1,""],LogicalRouterScope:[2,1,1,""],LogicalRouterScopes:[2,1,1,""],MacAddress:[2,1,1,""],MaintenanceWindow:[2,1,1,""],MaintenanceWindowEntry:[2,1,1,""],MaintenanceWindowGet:[2,1,1,""],ManagementGatewayTemplate:[2,1,1,""],MapZonesRequest:[2,1,1,""],MetaDashboardStats:[2,1,1,""],Metadata:[2,1,1,""],Nat:[2,1,1,""],NatRule:[2,1,1,""],NatRules:[2,1,1,""],NetworkTemplate:[2,1,1,""],NewCredentials:[2,1,1,""],Nsxfirewallrule:[2,1,1,""],Nsxfirewallservice:[2,1,1,""],Nsxl2vpn:[2,1,1,""],Nsxnatrule:[2,1,1,""],Nsxsite:[2,1,1,""],NsxtAddons:[2,1,1,""],ObjectType:[2,1,1,""],OfferInstancesHolder:[2,1,1,""],OfferType:[2,1,1,""],OnDemandOfferInstance:[2,1,1,""],OrgProperties:[2,1,1,""],Organization:[2,1,1,""],PagedEdgeList:[2,1,1,""],PagingInfo:[2,1,1,""],PopAgentXeniConnection:[2,1,1,""],PopAmiInfo:[2,1,1,""],PopInfo:[2,1,1,""],PopServiceInfo:[2,1,1,""],Requests:[2,1,1,""],Reservation:[2,1,1,""],ReservationInMw:[2,1,1,""],ReservationSchedule:[2,1,1,""],ReservationWindow:[2,1,1,""],ReservationWindowMaintenanceProperties:[2,1,1,""],Result:[2,1,1,""],ScopeInfo:[2,1,1,""],Sddc:[2,1,1,""],SddcAllocatePublicIpSpec:[2,1,1,""],SddcConfig:[2,1,1,""],SddcId:[2,1,1,""],SddcLinkConfig:[2,1,1,""],SddcManifest:[2,1,1,""],SddcNetwork:[2,1,1,""],SddcNetworkAddressGroup:[2,1,1,""],SddcNetworkAddressGroups:[2,1,1,""],SddcNetworkDhcpConfig:[2,1,1,""],SddcNetworkDhcpIpPool:[2,1,1,""],SddcPatchRequest:[2,1,1,""],SddcPublicIp:[2,1,1,""],SddcResourceConfig:[2,1,1,""],SddcStateRequest:[2,1,1,""],SddcTemplate:[2,1,1,""],SecondaryAddresses:[2,1,1,""],ServiceError:[2,1,1,""],Site:[2,1,1,""],Sites:[2,1,1,""],SslvpnDashboardStats:[2,1,1,""],StubFactory:[2,1,1,""],SubInterface:[2,1,1,""],SubInterfaces:[2,1,1,""],SubnetInfo:[2,1,1,""],Subnets:[2,1,1,""],SubscriptionDetails:[2,1,1,""],SubscriptionProducts:[2,1,1,""],SubscriptionRequest:[2,1,1,""],SupportWindow:[2,1,1,""],SupportWindowId:[2,1,1,""],Task:[2,1,1,""],TaskProgressPhase:[2,1,1,""],TermOfferInstance:[2,1,1,""],TrafficShapingPolicy:[2,1,1,""],UpdateCredentials:[2,1,1,""],VmcLocale:[2,1,1,""],Vnic:[2,1,1,""],Vnics:[2,1,1,""],VpcInfo:[2,1,1,""],VpcInfoSubnets:[2,1,1,""],Vpn:[2,1,1,""],VpnChannelStatus:[2,1,1,""],VpnTunnelStatus:[2,1,1,""],VpnTunnelTrafficStats:[2,1,1,""],VsanConfigConstraints:[2,1,1,""],VsanEncryptionConfig:[2,1,1,""]},"com.vmware.vmc.model_client.Agent":{AGENT_STATE_CUSTOMIZING:[2,2,1,""],AGENT_STATE_DELETED:[2,2,1,""],AGENT_STATE_DELETING:[2,2,1,""],AGENT_STATE_DEPLOYING:[2,2,1,""],AGENT_STATE_FAILED:[2,2,1,""],AGENT_STATE_NOT_READY:[2,2,1,""],AGENT_STATE_READY:[2,2,1,""],provider:[2,3,1,""]},"com.vmware.vmc.model_client.AwsAgent":{provider:[2,3,1,""]},"com.vmware.vmc.model_client.AwsCloudProvider":{provider:[2,3,1,""]},"com.vmware.vmc.model_client.AwsCustomerConnectedAccount":{STATE_ACTIVE:[2,2,1,""],STATE_BROKEN:[2,2,1,""],STATE_DELETED:[2,2,1,""]},"com.vmware.vmc.model_client.AwsEsxHost":{provider:[2,3,1,""]},"com.vmware.vmc.model_client.AwsSddcConfig":{provider:[2,3,1,""]},"com.vmware.vmc.model_client.AwsSddcConnection":{STATE_ACTIVE:[2,2,1,""],STATE_BROKEN:[2,2,1,""],STATE_DELETED:[2,2,1,""]},"com.vmware.vmc.model_client.AwsSddcResourceConfig":{provider:[2,3,1,""]},"com.vmware.vmc.model_client.CloudProvider":{provider:[2,3,1,""]},"com.vmware.vmc.model_client.Cluster":{CLUSTER_STATE_ADDING_HOSTS:[2,2,1,""],CLUSTER_STATE_DEPLOYING:[2,2,1,""],CLUSTER_STATE_FAILED:[2,2,1,""],CLUSTER_STATE_READY:[2,2,1,""]},"com.vmware.vmc.model_client.ConnectivityAgentValidation":{SOURCE_SRM:[2,2,1,""],SOURCE_VCENTER:[2,2,1,""],SOURCE_VR:[2,2,1,""],TYPE_CONNECTIVITY:[2,2,1,""],TYPE_CURL:[2,2,1,""],TYPE_DNS:[2,2,1,""],TYPE_PING:[2,2,1,""],TYPE_TRACEROUTE:[2,2,1,""]},"com.vmware.vmc.model_client.ConnectivityValidationGroup":{ID_DRAAS:[2,2,1,""],ID_HLM:[2,2,1,""]},"com.vmware.vmc.model_client.ConnectivityValidationInput":{ID_HOSTNAME:[2,2,1,""],ID_HOSTNAME_OR_IP:[2,2,1,""],ID_HOST_IP:[2,2,1,""]},"com.vmware.vmc.model_client.ConnectivityValidationSubGroup":{ID_ACTIVE_DIRECTORY:[2,2,1,""],ID_DRAAS_ONPREM_PSC:[2,2,1,""],ID_DRAAS_ONPREM_SRM:[2,2,1,""],ID_DRAAS_ONPREM_VCENTER:[2,2,1,""],ID_DRAAS_ONPREM_VR:[2,2,1,""],ID_ONPREM_ESX:[2,2,1,""],ID_ONPREM_PSC:[2,2,1,""],ID_ONPREM_VCENTER:[2,2,1,""],ID_PRIMARY_DNS:[2,2,1,""],ID_SECONDARY_DNS:[2,2,1,""]},"com.vmware.vmc.model_client.EsxHost":{ESX_STATE_DELETED:[2,2,1,""],ESX_STATE_DELETING:[2,2,1,""],ESX_STATE_DEPLOYING:[2,2,1,""],ESX_STATE_FAILED:[2,2,1,""],ESX_STATE_PROVISIONED:[2,2,1,""],ESX_STATE_READY:[2,2,1,""],provider:[2,3,1,""]},"com.vmware.vmc.model_client.FirewallRule":{ACTION_ALLOW:[2,2,1,""],ACTION_DENY:[2,2,1,""],RULE_TYPE_DEFAULT:[2,2,1,""],RULE_TYPE_USER:[2,2,1,""]},"com.vmware.vmc.model_client.FirewallRuleScope":{VNIC_GROUP_IDS_EXTERNAL:[2,2,1,""],VNIC_GROUP_IDS_INTERNAL:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_0:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_1:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_2:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_3:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_4:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_5:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_6:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_7:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_8:[2,2,1,""],VNIC_GROUP_IDS_VNIC_INDEX_9:[2,2,1,""],VNIC_GROUP_IDS_VSE:[2,2,1,""]},"com.vmware.vmc.model_client.LogicalNetwork":{NETWORK_TYPE_EXTENDED:[2,2,1,""],NETWORK_TYPE_HOSTED:[2,2,1,""],NETWORK_TYPE_ROUTED:[2,2,1,""]},"com.vmware.vmc.model_client.MaintenanceWindow":{DAY_OF_WEEK_FRIDAY:[2,2,1,""],DAY_OF_WEEK_MONDAY:[2,2,1,""],DAY_OF_WEEK_SATURDAY:[2,2,1,""],DAY_OF_WEEK_SUNDAY:[2,2,1,""],DAY_OF_WEEK_THURSDAY:[2,2,1,""],DAY_OF_WEEK_TUESDAY:[2,2,1,""],DAY_OF_WEEK_WEDNESDAY:[2,2,1,""]},"com.vmware.vmc.model_client.MaintenanceWindowGet":{DAY_OF_WEEK_FRIDAY:[2,2,1,""],DAY_OF_WEEK_MONDAY:[2,2,1,""],DAY_OF_WEEK_SATURDAY:[2,2,1,""],DAY_OF_WEEK_SUNDAY:[2,2,1,""],DAY_OF_WEEK_THURSDAY:[2,2,1,""],DAY_OF_WEEK_TUESDAY:[2,2,1,""],DAY_OF_WEEK_WEDNESDAY:[2,2,1,""]},"com.vmware.vmc.model_client.NatRule":{ACTION_DNAT:[2,2,1,""],ACTION_SNAT:[2,2,1,""]},"com.vmware.vmc.model_client.OfferType":{ON_DEMAND:[2,2,1,""],TERM:[2,2,1,""]},"com.vmware.vmc.model_client.Organization":{PROJECT_STATE_CREATED:[2,2,1,""],PROJECT_STATE_DELETED:[2,2,1,""]},"com.vmware.vmc.model_client.PopAmiInfo":{TYPE_CENTOS:[2,2,1,""],TYPE_POP:[2,2,1,""]},"com.vmware.vmc.model_client.PopServiceInfo":{SERVICE_AGENT:[2,2,1,""],SERVICE_AIDE:[2,2,1,""],SERVICE_BRE:[2,2,1,""],SERVICE_BRF:[2,2,1,""],SERVICE_DNS:[2,2,1,""],SERVICE_DOCKER:[2,2,1,""],SERVICE_FM_LOG_COLLECTOR:[2,2,1,""],SERVICE_FM_METRICS_COLLECTOR:[2,2,1,""],SERVICE_FORWARD_PROXY:[2,2,1,""],SERVICE_GLCM:[2,2,1,""],SERVICE_JRE:[2,2,1,""],SERVICE_LOGZ_LOG_COLLECTOR:[2,2,1,""],SERVICE_NTP:[2,2,1,""],SERVICE_OS:[2,2,1,""],SERVICE_REVERSE_PROXY:[2,2,1,""],SERVICE_RTS:[2,2,1,""],SERVICE_S3_ADAPTER:[2,2,1,""]},"com.vmware.vmc.model_client.ReservationSchedule":{DAY_OF_WEEK_FRIDAY:[2,2,1,""],DAY_OF_WEEK_MONDAY:[2,2,1,""],DAY_OF_WEEK_SATURDAY:[2,2,1,""],DAY_OF_WEEK_SUNDAY:[2,2,1,""],DAY_OF_WEEK_THURSDAY:[2,2,1,""],DAY_OF_WEEK_TUESDAY:[2,2,1,""],DAY_OF_WEEK_WEDNESDAY:[2,2,1,""]},"com.vmware.vmc.model_client.ReservationWindow":{RESERVATION_STATE_CANCELED:[2,2,1,""],RESERVATION_STATE_COMPLETED:[2,2,1,""],RESERVATION_STATE_RUNNING:[2,2,1,""],RESERVATION_STATE_SCHEDULED:[2,2,1,""]},"com.vmware.vmc.model_client.Sddc":{ACCOUNT_LINK_STATE_DELAYED:[2,2,1,""],ACCOUNT_LINK_STATE_LINKED:[2,2,1,""],ACCOUNT_LINK_STATE_UNLINKED:[2,2,1,""],PROVIDER_AWS:[2,2,1,""],SDDC_STATE_DELETED:[2,2,1,""],SDDC_STATE_DELETING:[2,2,1,""],SDDC_STATE_DELETION_FAILED:[2,2,1,""],SDDC_STATE_DEPLOYING:[2,2,1,""],SDDC_STATE_FAILED:[2,2,1,""],SDDC_STATE_READY:[2,2,1,""]},"com.vmware.vmc.model_client.SddcConfig":{DEPLOYMENT_TYPE_MULTIAZ:[2,2,1,""],DEPLOYMENT_TYPE_SINGLEAZ:[2,2,1,""],PROVIDER_AWS:[2,2,1,""],provider:[2,3,1,""]},"com.vmware.vmc.model_client.SddcResourceConfig":{DEPLOYMENT_TYPE_MULTI_AZ:[2,2,1,""],DEPLOYMENT_TYPE_SINGLE_AZ:[2,2,1,""],PROVIDER_AWS:[2,2,1,""],provider:[2,3,1,""]},"com.vmware.vmc.model_client.SddcStateRequest":{STATES_CANCELED:[2,2,1,""],STATES_COMPLETED:[2,2,1,""],STATES_RUNNING:[2,2,1,""],STATES_SCHEDULED:[2,2,1,""]},"com.vmware.vmc.model_client.SddcTemplate":{STATE_APPLIED:[2,2,1,""],STATE_AVAILABLE:[2,2,1,""],STATE_DELETED:[2,2,1,""],STATE_DELETING:[2,2,1,""],STATE_FAILED:[2,2,1,""],STATE_INITIALIZATION:[2,2,1,""],STATE_INUSE:[2,2,1,""]},"com.vmware.vmc.model_client.Site":{TUNNEL_STATUS_CONNECTED:[2,2,1,""],TUNNEL_STATUS_DISCONNECTED:[2,2,1,""],TUNNEL_STATUS_UNKNOWN:[2,2,1,""]},"com.vmware.vmc.model_client.SubscriptionDetails":{STATUS_ACTIVATED:[2,2,1,""],STATUS_CANCELLED:[2,2,1,""],STATUS_CREATED:[2,2,1,""],STATUS_EXPIRED:[2,2,1,""],STATUS_FAILED:[2,2,1,""],STATUS_ORDER_SUBMITTED:[2,2,1,""],STATUS_PENDING_PROVISIONING:[2,2,1,""]},"com.vmware.vmc.model_client.SupportWindow":{START_DAY_FRIDAY:[2,2,1,""],START_DAY_MONDAY:[2,2,1,""],START_DAY_SATURDAY:[2,2,1,""],START_DAY_SUNDAY:[2,2,1,""],START_DAY_THURSDAY:[2,2,1,""],START_DAY_TUESDAY:[2,2,1,""],START_DAY_WEDNESDAY:[2,2,1,""]},"com.vmware.vmc.model_client.Task":{STATUS_CANCELED:[2,2,1,""],STATUS_CANCELING:[2,2,1,""],STATUS_FAILED:[2,2,1,""],STATUS_FINISHED:[2,2,1,""],STATUS_STARTED:[2,2,1,""]},"com.vmware.vmc.model_client.Vpn":{AUTHENTICATION_PSK:[2,2,1,""],AUTHENTICATION_UNKNOWN:[2,2,1,""],DH_GROUP_DH14:[2,2,1,""],DH_GROUP_DH15:[2,2,1,""],DH_GROUP_DH16:[2,2,1,""],DH_GROUP_DH2:[2,2,1,""],DH_GROUP_DH5:[2,2,1,""],DH_GROUP_UNKNOWN:[2,2,1,""],DIGEST_ALGORITHM_SHA1:[2,2,1,""],DIGEST_ALGORITHM_SHA_256:[2,2,1,""],ENCRYPTION_AES256:[2,2,1,""],ENCRYPTION_AES:[2,2,1,""],ENCRYPTION_AES_GCM:[2,2,1,""],ENCRYPTION_TRIPLE_DES:[2,2,1,""],ENCRYPTION_UNKNOWN:[2,2,1,""],IKE_OPTION_IKEV1:[2,2,1,""],IKE_OPTION_IKEV2:[2,2,1,""],STATE_CONNECTED:[2,2,1,""],STATE_DISCONNECTED:[2,2,1,""],STATE_PARTIALLY_CONNECTED:[2,2,1,""],STATE_UNKNOWN:[2,2,1,""]},"com.vmware.vmc.model_client.VpnChannelStatus":{CHANNEL_STATUS_CONNECTED:[2,2,1,""],CHANNEL_STATUS_DISCONNECTED:[2,2,1,""],CHANNEL_STATUS_UNKNOWN:[2,2,1,""]},"com.vmware.vmc.model_client.VpnTunnelStatus":{TUNNEL_STATUS_CONNECTED:[2,2,1,""],TUNNEL_STATUS_DISCONNECTED:[2,2,1,""],TUNNEL_STATUS_UNKNOWN:[2,2,1,""]},"com.vmware.vmc.orgs":{account_link_client:[3,0,0,"-"],reservations_client:[3,0,0,"-"],sddcs:[4,0,0,"-"],sddcs_client:[3,0,0,"-"],storage_client:[3,0,0,"-"],subscriptions_client:[3,0,0,"-"],tbrs_client:[3,0,0,"-"]},"com.vmware.vmc.orgs.account_link_client":{CompatibleSubnets:[3,1,1,""],CompatibleSubnetsAsync:[3,1,1,""],ConnectedAccounts:[3,1,1,""],MapCustomerZones:[3,1,1,""],SddcConnections:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.vmc.orgs.account_link_client.CompatibleSubnets":{get:[3,3,1,""],post:[3,3,1,""]},"com.vmware.vmc.orgs.account_link_client.CompatibleSubnetsAsync":{get:[3,3,1,""],post:[3,3,1,""]},"com.vmware.vmc.orgs.account_link_client.ConnectedAccounts":{"delete":[3,3,1,""],get:[3,3,1,""]},"com.vmware.vmc.orgs.account_link_client.MapCustomerZones":{post:[3,3,1,""]},"com.vmware.vmc.orgs.account_link_client.SddcConnections":{get:[3,3,1,""]},"com.vmware.vmc.orgs.reservations_client":{Mw:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.vmc.orgs.reservations_client.Mw":{get:[3,3,1,""],put:[3,3,1,""]},"com.vmware.vmc.orgs.sddcs":{addons_client:[4,0,0,"-"],dns_client:[4,0,0,"-"],management_vms_client:[4,0,0,"-"],networking_client:[4,0,0,"-"],networks:[5,0,0,"-"],networks_client:[4,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.addons_client":{Credentials:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.vmc.orgs.sddcs.addons_client.Credentials":{CREATE_ADDON_TYPE_HCX:[4,2,1,""],GET_ADDON_TYPE_HCX:[4,2,1,""],LIST_ADDON_TYPE_HCX:[4,2,1,""],UPDATE_ADDON_TYPE_HCX:[4,2,1,""],create:[4,3,1,""],get:[4,3,1,""],list:[4,3,1,""],update:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.dns_client":{Private:[4,1,1,""],Public:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.vmc.orgs.sddcs.dns_client.Private":{update:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.dns_client.Public":{update:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.management_vms_client":{Dns:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.vmc.orgs.sddcs.management_vms_client.Dns":{UPDATE_IP_TYPE_PRIVATE:[4,2,1,""],UPDATE_IP_TYPE_PUBLIC:[4,2,1,""],update:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.networking_client":{ConnectivityTests:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.vmc.orgs.sddcs.networking_client.ConnectivityTests":{get:[4,3,1,""],post:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks":{cgws:[6,0,0,"-"],edges:[7,0,0,"-"],edges_client:[5,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.cgws":{l2vpn_client:[6,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client":{Config:[6,1,1,""],StubFactory:[6,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.Config":{"delete":[6,3,1,""],get:[6,3,1,""],update:[6,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges":{dhcp_client:[7,0,0,"-"],dns_client:[7,0,0,"-"],firewall:[8,0,0,"-"],firewall_client:[7,0,0,"-"],ipsec_client:[7,0,0,"-"],l2vpn:[9,0,0,"-"],nat:[10,0,0,"-"],nat_client:[7,0,0,"-"],statistics:[11,0,0,"-"],statistics_client:[7,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client":{Leaseinfo:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.Leaseinfo":{get:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.dns_client":{Config:[7,1,1,""],Statistics:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Config":{"delete":[7,3,1,""],create:[7,3,1,""],get:[7,3,1,""],update:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.Statistics":{get:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall":{config_client:[8,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client":{Rules:[8,1,1,""],StubFactory:[8,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.Rules":{"delete":[8,3,1,""],add:[8,3,1,""],get:[8,3,1,""],update:[8,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client":{Config:[7,1,1,""],Statistics:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Config":{"delete":[7,3,1,""],get:[7,3,1,""],update:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.Statistics":{get:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client":{Config:[7,1,1,""],Statistics:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Config":{"delete":[7,3,1,""],get:[7,3,1,""],update:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.Statistics":{get:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn":{config_client:[9,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client":{Statistics:[9,1,1,""],StubFactory:[9,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.Statistics":{get:[9,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.nat":{config_client:[10,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client":{Rules:[10,1,1,""],StubFactory:[10,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.Rules":{"delete":[10,3,1,""],add:[10,3,1,""],update:[10,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.nat_client":{Config:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.Config":{"delete":[7,3,1,""],get:[7,3,1,""],update:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics":{dashboard_client:[11,0,0,"-"],interfaces_client:[11,0,0,"-"]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client":{Firewall:[11,1,1,""],Interface:[11,1,1,""],Ipsec:[11,1,1,""],StubFactory:[11,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Firewall":{get:[11,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Interface":{get:[11,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.Ipsec":{get:[11,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client":{Internal:[11,1,1,""],StubFactory:[11,1,1,""],Uplink:[11,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Internal":{get:[11,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.Uplink":{get:[11,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client":{Interfaces:[7,1,1,""],StubFactory:[7,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.Interfaces":{get:[7,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges_client":{Peerconfig:[5,1,1,""],Status:[5,1,1,""],StubFactory:[5,1,1,""],Vnics:[5,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges_client.Peerconfig":{get:[5,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges_client.Status":{get:[5,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks.edges_client.Vnics":{get:[5,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks_client":{Edges:[4,1,1,""],Logical:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.vmc.orgs.sddcs.networks_client.Edges":{get:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs.networks_client.Logical":{"delete":[4,3,1,""],create:[4,3,1,""],get:[4,3,1,""],get_0:[4,3,1,""],update:[4,3,1,""]},"com.vmware.vmc.orgs.sddcs_client":{Clusters:[3,1,1,""],Convert:[3,1,1,""],Esxs:[3,1,1,""],Publicips:[3,1,1,""],SddcTemplate:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.vmc.orgs.sddcs_client.Clusters":{"delete":[3,3,1,""],create:[3,3,1,""]},"com.vmware.vmc.orgs.sddcs_client.Convert":{create:[3,3,1,""]},"com.vmware.vmc.orgs.sddcs_client.Esxs":{create:[3,3,1,""]},"com.vmware.vmc.orgs.sddcs_client.Publicips":{"delete":[3,3,1,""],create:[3,3,1,""],get:[3,3,1,""],list:[3,3,1,""],update:[3,3,1,""]},"com.vmware.vmc.orgs.sddcs_client.SddcTemplate":{get:[3,3,1,""]},"com.vmware.vmc.orgs.storage_client":{ClusterConstraints:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.vmc.orgs.storage_client.ClusterConstraints":{get:[3,3,1,""]},"com.vmware.vmc.orgs.subscriptions_client":{OfferInstances:[3,1,1,""],Products:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.vmc.orgs.subscriptions_client.OfferInstances":{list:[3,3,1,""]},"com.vmware.vmc.orgs.subscriptions_client.Products":{list:[3,3,1,""]},"com.vmware.vmc.orgs.tbrs_client":{Reservation:[3,1,1,""],StubFactory:[3,1,1,""],SupportWindow:[3,1,1,""]},"com.vmware.vmc.orgs.tbrs_client.Reservation":{post:[3,3,1,""]},"com.vmware.vmc.orgs.tbrs_client.SupportWindow":{get:[3,3,1,""],put:[3,3,1,""]},"com.vmware.vmc.orgs_client":{AccountLink:[2,1,1,""],Providers:[2,1,1,""],Reservations:[2,1,1,""],SddcTemplates:[2,1,1,""],Sddcs:[2,1,1,""],StubFactory:[2,1,1,""],Subscriptions:[2,1,1,""],Tasks:[2,1,1,""]},"com.vmware.vmc.orgs_client.AccountLink":{get:[2,3,1,""]},"com.vmware.vmc.orgs_client.Providers":{list:[2,3,1,""]},"com.vmware.vmc.orgs_client.Reservations":{list:[2,3,1,""]},"com.vmware.vmc.orgs_client.SddcTemplates":{"delete":[2,3,1,""],get:[2,3,1,""],list:[2,3,1,""]},"com.vmware.vmc.orgs_client.Sddcs":{"delete":[2,3,1,""],create:[2,3,1,""],get:[2,3,1,""],list:[2,3,1,""],patch:[2,3,1,""]},"com.vmware.vmc.orgs_client.Subscriptions":{GET_0_OFFER_TYPE_ON_DEMAND:[2,2,1,""],GET_0_OFFER_TYPE_TERM:[2,2,1,""],create:[2,3,1,""],get:[2,3,1,""],get_0:[2,3,1,""]},"com.vmware.vmc.orgs_client.Tasks":{get:[2,3,1,""],list:[2,3,1,""],update:[2,3,1,""]},"com.vmware.vmc_client":{Locale:[1,1,1,""],Orgs:[1,1,1,""],StubFactory:[1,1,1,""]},"com.vmware.vmc_client.Locale":{set:[1,3,1,""]},"com.vmware.vmc_client.Orgs":{get:[1,3,1,""],list:[1,3,1,""]},"vmware.vapi":{vmc:[16,0,0,"-"]},"vmware.vapi.vmc":{client:[16,0,0,"-"],csp_filter:[16,0,0,"-"]},"vmware.vapi.vmc.client":{PUBLIC_CSP_URL:[16,4,1,""],PUBLIC_VMC_URL:[16,4,1,""],VmcClient:[16,1,1,""],create_vmc_client:[16,5,1,""]},"vmware.vapi.vmc.csp_filter":{CSPSecurityContextFilter:[16,1,1,""]},"vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter":{get_max_retries:[16,3,1,""],get_security_context:[16,3,1,""],should_retry:[16,3,1,""]},com:{vmware:[1,0,0,"-"]},vmware:{vapi:[15,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","data","Python data"],"5":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:data","5":"py:function"},terms:{"00z":2,"09t13":2,"278710ff4e":2,"3de":2,"4d4e":2,"6b6d":2,"boolean":2,"byte":2,"case":[2,16],"class":[1,2,3,4,5,6,7,8,9,10,11,12,16],"default":[2,3,4,5,7,11],"enum":[2,12],"final":2,"float":2,"import":12,"int":16,"long":[2,3,4,7,8,10,11],"new":[2,3,4,12,16],"null":2,"public":[2,3,4,16],"return":[1,2,3,4,5,6,7,8,9,11,16],"switch":2,"true":[2,3,4,5,7,16],"try":3,"while":2,AES:2,AWS:[2,3],DNS:[2,4,7],Dns:[2,4],EBS:[2,3],For:[2,3],IDs:2,IPs:[2,3],NOT:2,Not:[2,4,5,6,7,8,9,10,11],RTS:2,The:[1,2,3,4,5,12],These:2,Used:2,Using:2,VMs:[2,3,4],abandon:2,about:[3,4],abstractent:2,accept:2,access:[2,3,16],access_permiss:2,accompani:3,account:[2,3],account_link_cli:[0,1,2,13],account_link_config:2,account_link_sddc_config:2,account_link_st:2,account_link_state_delai:2,account_link_state_link:2,account_link_state_unlink:2,account_numb:2,accountlink:2,accountlinkconfig:2,accountlinksddcconfig:2,across:3,act:2,action:[2,3,4],action_allow:2,action_deni:2,action_dnat:2,action_snat:2,activ:[2,3],active_cli:2,active_directori:2,active_vse_ha_index:2,add:[2,3,4,8,10,16],added:[2,16],adding_host:2,addit:2,addon:[2,4],addon_typ:4,addons_cli:[0,1,2,3,13],addontyp:4,address:[2,3,4],address_group:2,addressfwsourcedestin:2,addtoal:3,administr:2,advanc:2,advisori:2,aefb:2,aes256:2,aes:2,aes_gcm:2,after:16,against:2,agent:2,agent_st:2,agent_state_custom:2,agent_state_delet:2,agent_state_deploi:2,agent_state_fail:2,agent_state_not_readi:2,agent_state_readi:2,agent_url:2,aggreg:5,aid:2,alert:2,algorithm:2,all:[1,2,3,4,5,7,16],alloc:[2,3],allocation_id:2,allow:[2,3,12,16],allowed_act:2,also:2,alwai:2,amazon_resource_nam:2,ami:2,ami_info:2,amiinfo:2,among:2,amount:2,ani:[2,3],anniversary_billing_d:2,anoth:2,answer:2,api:[2,3,12,16],api_association_id:2,api_subnet_id:2,api_vers:2,apicli:16,append:[8,10],appli:2,applianc:2,appliance_s:2,appliances_summari:2,appliancessummari:2,applic:2,application_id:2,arbitrari:2,argument:2,arn:2,arp:2,arrai:2,ascend:4,assign:2,associ:[2,4],associated_private_ip:[2,3],association_id:2,assoic:4,attach:[2,3],attack:2,attch:3,attribut:[2,12],attrit:12,auth_failur:2,authent:2,authentication_algorithm:2,authentication_mod:2,authentication_psk:2,authentication_unknown:2,author:[1,4,5,6,7,8,9,10,11],auto_renewed_allow:2,automat:16,avail:[2,3,4,5],availability_zon:2,average_bandwidth:2,avoid:2,awar:2,aws_kms_info:2,aws_subnet:3,awsag:2,awscloudprovid:2,awscompatiblesubnet:[2,3],awscustomerconnectedaccount:[2,3],awsesxhost:2,awskeypair:2,awskmsinfo:2,awssddcconfig:2,awssddcconnect:[2,3],awssddcresourceconfig:2,awssubnet:[2,3],back:[2,3,12],backup_restore_bucket:2,backward:2,bad:[2,3,4,5,6,7,8,9,10,11],balanc:2,base:[1,2,3,4,5,6,7,8,9,10,11,12,16],been:[2,3],befor:[2,3],behaviour:3,being:2,belong:2,between:2,bewar:2,billing_subscription_id:2,binari:2,bind:[1,2,3,4,5,6,7,8,9,10,11,12,16],binding_st:2,blank:2,block:2,bodi:[2,4],bogu:2,bool:[2,3,4,5,6,7,16],both:12,bound:3,bre:2,brf:2,bridg:2,broken:2,bucket:2,build:2,bundl:2,burst_siz:2,byte_count:2,c41:2,ca637f38609:2,ca_certif:2,cacertif:2,cach:2,cache_s:2,cached_dbrr_set:2,call:[1,3,16],can:[2,3,11,12],cancel:2,cannot:[2,3],capabl:2,capac:2,care:3,carri:2,cbmstatist:[2,7,11],cbmstatsdata:2,cento:2,centric:2,cert_en:2,certif:2,cf_stack_nam:2,cgw:[0,1,2,3,4,5],cgw_id:2,cgw_name:2,cgw_present:2,chain:16,chanc:2,chang:2,channel:2,channel_st:2,channel_statu:2,channel_status_connect:2,channel_status_disconnect:2,channel_status_unknown:2,charact:2,characterist:2,check:2,choic:2,chosen:3,cidr:2,cidr_block:2,cidr_block_subnet:2,cidr_block_vpc:2,cipher:2,client:[2,13,14,15],client_handl:2,client_hostnam:2,cln:2,close:2,cloud:[2,3,16],cloud_password:2,cloud_user_group:2,cloud_usernam:2,cloudprovid:2,cltt:2,cluster:[2,3],cluster_config:3,cluster_id:2,cluster_nam:2,cluster_st:2,cluster_state_adding_host:2,cluster_state_deploi:2,cluster_state_fail:2,cluster_state_readi:2,clusterconfig:[2,3],clusterconstraint:3,code:2,collect:2,column:4,com:[12,13,16],comma:2,commit:2,commitment_term:2,commitment_term_uom:2,common:2,commun:[2,12],communication_channel:2,compat:[2,3],compatiblesubnet:3,compatiblesubnetsasync:3,complet:[2,3],compon:2,compos:2,comput:[2,4,5,6,7,8,9,10,11],compute_gateway_templ:2,computegatewaytempl:2,concurr:2,concurrentchang:[3,4],config:[1,2,3,4,5,6,7,8,9,10,11],config_cli:[0,1,2,3,4,5,7],configur:[1,2,3,4,5,6,7,8,9,10,11],configuration_limit:2,conflict:3,connect:[2,3,4],connected_account_id:2,connectedaccount:3,connection_count:2,connection_ord:2,connectivityagentvalid:2,connectivitytest:4,connectivityvalidationgroup:[2,4],connectivityvalidationgroupresultwrapp:4,connectivityvalidationinput:2,connectivityvalidationsubgroup:2,connector:16,consecut:2,consid:2,consol:16,constraint:3,consum:2,contain:[2,12],content:13,context:16,control:2,convei:2,convert:3,core:[2,16],correl:2,correlation_id:2,correspond:2,count:2,countri:2,cpu:2,creat:[1,2,3,4,5,6,7,8,9,10,11,12,16],create_addon_type_hcx:4,create_tim:2,create_vmc_cli:16,created_at:2,created_bi:3,createspec:12,creation:[2,4],credenti:[1,2,4],critic:2,crl:2,crl_certif:2,crlcertif:2,cross:2,csp:16,csp_filter:[13,14,15],csp_subscription_id:2,csp_url:16,cspsecuritycontextfilt:16,curl:2,currenc:2,current:[2,3,4,12],custom:[2,3],custom_properti:2,customer_available_zon:2,customer_eni_info:2,customer_subnet_id:2,customereniinfo:2,cycl:2,cycle_id:2,dashboard:[2,11],dashboard_cli:[0,1,2,3,4,5,7],dashboarddata:2,dashboardstat:2,dashboardstatist:[2,11],data:[2,3,7,16],data_dto:2,data_permiss:2,data_store_moid_of_active_vs:2,data_store_name_of_active_vs:2,databas:5,datacent:[2,3],datacenter_moid:2,datacenter_nam:2,datapageedgesummari:2,datapagesddcnetwork:[2,4],datapermiss:2,datastor:2,date:2,datetim:2,day_of_week:2,day_of_week_fridai:2,day_of_week_mondai:2,day_of_week_saturdai:2,day_of_week_sundai:2,day_of_week_thursdai:2,day_of_week_tuesdai:2,day_of_week_wednesdai:2,ddthh:2,debug:2,decryption_failur:2,default_messag:2,default_polici:2,default_route_t:2,default_subnet_rout:2,defin:[2,12],definit:[2,3],delai:2,delay_account_link:2,delet:[2,3,4,6,7,8,10],deletion_fail:2,delimit:2,demand:2,deni:2,denot:2,deploi:2,deploy:2,deploy_appli:2,deployment_typ:2,deployment_type_multi_az:2,deployment_type_multiaz:2,deployment_type_single_az:2,deployment_type_singleaz:2,deprec:[2,3],deprecart:2,deriv:2,describ:2,descript:[2,4,12],destin:2,destination_scop:2,detach:3,detail:[1,2,4,5],detect:2,determin:2,dh14:2,dh15:2,dh16:2,dh2:2,dh5:2,dh_group:2,dh_group_dh14:2,dh_group_dh15:2,dh_group_dh16:2,dh_group_dh2:2,dh_group_dh5:2,dh_group_unknown:2,dhcp:[2,7],dhcp_client:[0,1,2,3,4,5],dhcp_config:2,dhcp_enabl:2,dhcp_ip_rang:2,dhcpleas:[2,7],dhcpleaseinfo:2,dict:[2,3],differ:2,diffi:2,digest_algorithm:2,digest_algorithm_sha1:2,digest_algorithm_sha_256:2,direct:2,disabl:[2,7],disable_ev:2,disconnect:2,discrimin:2,diskgroup:3,displai:2,display_nam:2,distinct:2,distribut:2,distributedportgroup:2,distributedrout:[2,4],distributedvirtualswitch:2,div:2,divid:2,dnat:2,dnat_match_source_address:2,dnat_match_source_port:2,dnat_rule_id:2,dns:2,dns_client:[0,1,2,3,5,13],dns_config:7,dns_server:2,dns_view:2,dns_with_management_vm_private_ip:2,dnsconfig:[2,7],dnsforward:2,dnslisten:2,dnsresponsestat:2,dnsstatusandstat:[2,7],dnsview:2,dnsviewmatch:2,docker:2,document:3,doe:[2,3,12],doesn:[1,2],domain:2,domain_nam:2,done:2,doubl:2,down:2,draa:2,draas_onprem_psc:2,draas_onprem_srm:2,draas_onprem_vcent:2,draas_onprem_vr:2,drop:2,drop_icmp_replai:2,drop_invalid_traff:2,dropped_rx_packet:2,dropped_tx_packet:2,dto:7,durat:2,duration_hour:2,duration_min:2,dvportgroup:2,dynamicstructur:5,each:2,edg:[0,1,2,3,4,5,6],edge_assist_id:2,edge_assist_instance_nam:2,edge_association_id:2,edge_id:[2,5,6,7,8,9,10,11],edge_pag:2,edge_statu:2,edge_subnet_id:2,edge_typ:[2,4],edge_vm_ha_index:2,edge_vm_statu:2,edgejob:2,edges_cli:[0,1,2,3,4],edgestatu:[2,5],edgesummari:2,edgevmstatu:2,edgevnicaddressgroup:2,egress:2,either:[2,16],els:[2,12,16],emerg:2,empti:2,enabl:[2,7],enable_bridge_mod:2,enable_fip:2,enable_nsx_advanced_addon:2,enable_pf:2,enable_proxy_arp:2,enable_send_redirect:2,enable_syn_flood_protect:2,enablefip:4,enclos:2,encript:2,encrypt:2,encryption_a:2,encryption_aes256:2,encryption_aes_gcm:2,encryption_algorithm:2,encryption_failur:2,encryption_triple_d:2,encryption_unknown:2,end:[2,7,11],end_dat:2,end_resource_entity_vers:2,end_tim:[2,7,11],endpoint:2,endswith:2,english:2,eni:2,eni_group:2,eni_id:2,eni_info:2,eniinfo:2,ensur:2,entir:2,entiti:[2,12],entity_metadata:12,entri:2,enumer:2,epoch:[7,11],error:[2,3,16],error_cod:2,error_messag:2,error_valu:16,errorrespons:2,errors_cli:[1,2,3,4,5,6,7,8,9,10,11],errorvalu:16,escap:2,establish:2,established_d:2,estim:2,estimated_remaining_minut:2,esx:[2,3],esx_ami:2,esx_cluster_id:2,esx_config:3,esx_host:2,esx_host_list:2,esx_host_subnet:2,esx_id:2,esx_nsxt_ami:2,esx_security_group_id:2,esx_stat:2,esx_state_delet:2,esx_state_deploi:2,esx_state_fail:2,esx_state_provis:2,esx_state_readi:2,esxconfig:[2,3],esxhost:2,etc:2,even:3,event:2,exampl:[2,3,5],exchang:16,exclud:2,execut:[2,16],exist:[1,2,3,4],exit:3,expir:2,expiration_d:2,explain:12,express:2,extend:2,extended_attribut:2,extendedattribut:2,extens:2,extern:2,extra:2,factor:2,factori:16,fail:2,failur:2,failure_messag:2,fals:[2,5,7,16],featur:[2,3,5],feature_cap:2,feature_status:2,feature_typ:2,featurecap:2,featurestatu:2,fence_paramet:2,fetch:4,field:2,file:12,filepath:12,filter:[2,3,4,16],find:[2,3,4],finish:[2,3],fip:2,firewal:[0,1,2,3,4,5,7,11],firewall_cli:[0,1,2,3,4,5],firewall_config:7,firewall_rul:[2,8],firewallconfig:[2,7],firewalldashboardstat:2,firewalldefaultpolici:2,firewallglobalconfig:2,firewallrul:[2,8],firewallrulescop:2,firewallrulestat:[2,7],firewallservic:2,first:[2,12],flag:2,flavor:3,flood:2,fm_log_collector:2,fm_metrics_collector:2,folder:12,follow:[2,12],forbidden:[1,2,3,4,5,6,7,8,9,10,11],forc:[2,3],force_even_when_sddc_pres:3,force_refresh:3,forcefulli:2,forcibl:3,form:[2,5],form_err:2,format:[2,5],forward:2,forward_proxi:2,found:[2,3,4,5,6,7,8,9,10,11],four:3,fqdn:[2,4],free:[3,5],fridai:2,from:[2,3,5,7,11,12,16],futur:12,gatewai:[2,4,5,6,7,8,9,10,11],gateway_ip:2,gatewayservic:[2,4],gatewaytempl:2,gcm:2,gener:[2,3,5,12],get:[1,2,3,4,5,6,7,8,9,11,12,16],get_0:[2,4],get_0_offer_type_on_demand:2,get_0_offer_type_term:2,get_addon_type_hcx:4,get_max_retri:16,get_security_context:16,getlatest:5,gib:2,given:[2,3,11],glcm:2,glcm_bundl:2,glcmbundl:2,global:2,global_:2,global_config:2,green:2,grei:2,group:2,grouping_object_id:2,groupingobject:2,ha_stat:2,ha_vnic_in_us:2,happen:2,hardwar:2,hardware_typ:2,has:[2,3,12],have:[2,3,12],hcx:4,header:[4,5,6,7,8,9,10,11],health:2,healthcheck:2,hellman:2,help:2,helper:16,high:[2,3],hlm:2,holder:2,host:[2,3],host_cpu_cores_count:2,host_ip:2,host_lease_info_dto:2,host_lease_infos_dto:2,host_moid_of_active_vs:2,host_name_of_active_vs:2,hostleaseinfo:2,hostnam:2,hostname_or_ip:2,hostname_verifier_en:2,hour_of_dai:2,how:12,http:[2,16],hypervisor_assist:2,icmp6:2,icmp6_timeout:2,icmp:2,icmp_timeout:2,icmp_typ:2,icmptyp:2,id_active_directori:2,id_draa:2,id_draas_onprem_psc:2,id_draas_onprem_srm:2,id_draas_onprem_vcent:2,id_draas_onprem_vr:2,id_hlm:2,id_host_ip:2,id_hostnam:2,id_hostname_or_ip:2,id_onprem_esx:2,id_onprem_psc:2,id_onprem_vcent:2,id_primary_dn:2,id_secondary_dn:2,idempot:2,identifi:[1,2,3,4,5,6,7,8,9,10,11],ignor:2,ike_opt:2,ike_option_ikev1:2,ike_option_ikev2:2,ike_statu:2,ikev1:2,ikev2:2,implement:2,in_:2,in_maintenance_mod:2,in_maintenance_window:2,in_shaping_polici:2,includ:[2,12],increment:2,index:[2,4,13],indic:2,individu:2,info:2,inform:[2,3,4],inherit:2,initi:[1,2,3,4,5,6,7,8,9,10,11,16],input:[2,4,5],instal:2,instanc:[1,2,3,4,5,6,7,8,9,10,11,12,16],instance_id:2,instance_typ:3,instanti:[2,12],instead:2,int32:2,int64:2,integrity_error:2,intend:2,interactionpermiss:2,interfac:[2,5,7,11],interfaces_cli:[0,1,2,3,4,5,7],interfacesdashboardstat:2,intermitt:2,intern:[2,3,11],internal_high:2,internal_ip:2,internal_network_id:2,internal_port:2,internal_public_ip_pool:2,internalservererror:[2,3],internet:2,internet_gateway_id:2,interv:[2,11],inus:2,invalid:[2,3,4,5,6,7,8,9,10,11],invalid_appl:2,invalid_destin:2,invalid_sourc:2,invalidrequest:[2,3,4,5,6,7,8,9,10,11],involv:2,ip1:2,ip_address:2,ip_generic_timeout:2,ip_pool:2,ip_rang:2,ip_set:2,ip_typ:4,ipaddress:2,ipn:2,ipsec:[2,5,7,11],ipsec_bytes_in:2,ipsec_bytes_out:2,ipsec_cli:[0,1,2,3,4,5],ipsec_tunnel:2,ipsecdashboardstat:2,ipsecglobalconfig:2,ipsecsit:[2,5],ipsecsiteconfig:5,ipsecsiteikestatu:2,ipsecsitestat:2,ipsecstatusandstat:[2,7],ipsectunnelstat:2,ipset:2,iptyp:4,ipv4:2,is_compat:2,is_connect:2,is_licens:2,is_mast:2,is_support:2,is_univers:2,is_upgrade_avail:2,isconnect:2,iso:2,its:2,job:2,job_id:2,jre:2,json:[5,12],just:2,kbp:2,keep:2,kei:2,key_fingerprint:2,key_materi:2,key_nam:2,key_pair:2,keyvalueattribut:2,kilobit:2,kms_vpc_endpoint:2,kmsvpcendpoint:2,l2_extens:2,l2_vpn:2,l2extens:2,l2vpn:[0,1,2,3,4,5,7],l2vpn_client:[0,1,2,3,4,5],l2vpnstat:2,l2vpnstatusandstat:[2,9],label:2,lan:2,languag:2,last:2,last_info_messag:2,last_informational_messag:2,last_published_pre_rules_generation_numb:2,last_updated_tim:2,later:2,latest:[2,5],layer:2,lb_bps_in:2,lb_bps_out:2,lb_http_req:2,lb_session:2,ld_rname:4,lead:3,leas:2,leaseinfo:7,least:2,left:2,legacyportgroup:2,length:2,letter:2,level:2,licenc:2,licenceaclpermiss:2,lif:2,limit:2,link:[2,3],linkag:2,linked_account_id:3,linked_account_path_id:3,list:[1,2,3,4],list_addon_type_hcx:4,listen:2,listener_ip:2,liter:2,live:5,load:2,load_balanc:2,loadbalancerdashboardstat:2,local:[1,2],local_egress_en:2,local_id:2,local_ip:2,local_ip_address:2,local_spi:2,local_subnet:2,localip:2,localized_error_messag:2,localized_messag:2,locat:2,log:2,log_icmp_error:2,log_invalid_traff:2,log_level:2,logging_en:2,logic:[2,4],logical_network:2,logical_router_scop:2,logical_switch_id:2,logical_switch_nam:2,logicalnetwork:2,logicalrouterscop:2,logicalswitch:2,logz_log_collector:2,loss:3,lower:2,lrouter_uuid:2,mac:2,mac_address:2,macaddress:2,machin:2,mai:[2,12],mainent:2,mainten:[2,3],maintenance_properti:2,maintenancewindow:[2,3],maintenancewindowentri:2,maintenancewindowget:[2,3],make:[2,16],manag:[2,4,5,7,8,10,11],manage_permiss:2,managedobjectrefer:2,management_d:2,management_gateway_templ:2,management_rp:2,management_vm_id:4,management_vms_cli:[0,1,2,3,13],managementgatewaytempl:2,mandatori:3,manifest:2,manifest_id:2,map:[2,3],map_zones_request:3,mapcustomerzon:3,mapzonesrequest:[2,3],mark:2,mask:2,master:2,match:[2,4],match_transl:2,max:[2,16],max_capac:2,max_num_public_ip:2,maximum:2,mean:2,meaning:2,measur:2,member:3,messag:2,meta_dto:2,metadashboardstat:2,metadata:[2,4,12],metadata_cli:12,metal:3,method:[2,3,4,12,16],mgmt_appliance_network_nam:2,mgw:2,mgw_id:2,might:2,millisecond:[7,11],min:[2,11],min_capac:2,minimum:[2,3],minimum_seats_avail:3,minu:2,minut:2,miss:3,mix:2,mod:2,mode:2,model:[1,2,3,4,5,6,7,8,9,11],model_cli:[0,1,3,4,5,6,7,8,9,10,11,13],modif:2,modifi:[2,4,6,7,8],modul:[0,12,13,14,15],moid:2,mondai:2,monitor:2,monthly_cost:2,more:[2,3],most:2,mostli:2,move:[2,3],mtu:2,mul:2,multi:2,multi_az:2,multiaz:2,multipl:2,must:[2,3],name:[2,3,4,12],nat:[0,1,2,3,4,5,7],nat_client:[0,1,2,3,4,5],nat_rul:[2,10],nat_rules_dto:2,natrul:[2,10],need:[2,3],nest:2,netmask:2,network:[0,1,2,3,4],network_gatewai:2,network_id:4,network_interface_id:2,network_netmask:2,network_templ:2,network_typ:2,network_type_extend:2,network_type_host:2,network_type_rout:2,networking_cli:[0,1,2,3,13],networks_cli:[0,1,2,3,13],networktempl:2,newcredenti:[2,4],newer:[2,12],next_binding_st:2,nic:2,node:[2,3],node_id:2,non:3,none:[2,3,4,5,6,7,11,16],not_readi:2,note:2,notfound:[1,2,3,4,5,6,7,8,9,10,11],notic:2,notifi:3,nsx:[2,4,5,7,8,9,10,11],nsx_api_public_endpoint_url:2,nsx_controller_ip:2,nsx_mgr_management_ip:2,nsx_mgr_url:2,nsxfirewallrul:[2,8],nsxfirewallservic:2,nsxl2vpn:[2,6],nsxnatrul:[2,10],nsxsite:2,nsxt:2,nsxt_addon:2,nsxtaddon:2,ntp:2,num_host:[2,3],number:[2,3,4,16],number_of_connected_vn:2,number_of_deployed_vm:2,nx_domain:2,nxrrset:2,object:[3,4,5,6,7,8,9,10,11,16],object_id:2,object_type_nam:2,objectid:5,objecttyp:[2,5],obtain:16,occur:16,off:3,offer:[2,3],offer_context_id:2,offer_nam:2,offer_typ:2,offer_vers:2,offerinst:3,offerinstanceshold:[2,3],offertyp:2,old:2,older:12,omit:2,on_demand:2,on_error:16,on_prem_gateway_ip:2,on_prem_nat_ip:2,on_prem_network_cidr:2,on_prem_subnet:2,onc:2,ondemandofferinst:2,one:[2,3,4,12,16],onedai:11,onemonth:11,oneweek:11,oneyear:11,ongo:2,onli:[2,12],onprem_esx:2,onprem_psc:2,onprem_vcent:2,ons:2,open:2,oper:[2,3],option:[2,3,4,5,6,7,11],order:[2,4],order_submit:2,org:[0,1,2,13],org_id:2,org_typ:2,organ:[1,2,3,4,5,6,7,8,9,10,11],orgid:2,orgproperti:2,orgs_client:[0,1,13],origin:2,original_address:2,original_port:2,original_servic:2,original_service_error_cod:2,other:[2,4],out:2,out_shaping_polici:2,output:5,over:2,overal:2,overwrit:2,packag:13,packet:2,packet_count:2,packet_received_error:2,packet_sent_error:2,packets_in:2,packets_out:2,page:[2,4,12,13],page_s:[2,4],pagededgelist:[2,4],pagin:4,paging_info:2,paginginfo:2,pair:2,param:[2,3,4],paramet:[1,2,3,4,5,6,7,8,9,10,11,12,16],parent_task_id:2,partially_connect:2,particular:3,partner:2,pass:[3,4,5,6,7,8,9,10,11,12,16],password:2,patch:2,path:2,pattern:2,payload:[3,4],peak_bandwidth:2,peer:[2,5],peer_id:2,peer_ip:2,peer_ip_address:2,peer_spi:2,peer_subnet:2,peerconfig:5,peering_connection_id:2,peerip:2,pending_provis:2,per:[2,4,5],percentag:2,perfect:2,perform:2,permiss:2,persist:2,perspect:2,petrona:2,petronas_regions_to_map:2,pfs_enabl:2,phase:2,phase_in_progress:2,physic:2,pick:2,ping:2,pipelin:2,platform:2,pleas:[2,3],plu:2,polici:2,policy_external_id:2,policy_payer_arn:2,policy_payer_linked_arn:2,policy_service_arn:2,pool:2,pop:2,pop_agent_xeni_connect:2,pop_info:2,popagentxeniconnect:2,popamiinfo:2,popinfo:2,popserviceinfo:2,port:2,portgroup:2,portgroup_id:2,portgroup_nam:2,possibl:[2,4],post:[3,4],power:3,pre:2,pre_rules_exist:2,pre_rules_generation_numb:2,pre_shared_kei:2,predefin:2,prefer:2,prefix:2,prefix_length:2,prem:2,present:2,prev_edge_id:4,prev_sddc_network_id:4,prevedgeid:4,previou:4,price:2,primari:2,primary_address:2,primary_dn:2,primary_ip_address:2,print:12,privat:[2,3,4],private_ip:2,private_subnet_id:2,privileg:[2,3],problem:2,process:[2,3],product:[2,3],product_charge_id:2,product_id:2,product_typ:[2,3],program:12,progress:2,progress_perc:2,project_st:2,project_state_cr:2,project_state_delet:2,properti:2,protect:2,protocol:2,provid:[2,3,4,5,6,7,8,9,10,11,12,16],provider_aw:2,providess:16,provis:2,proxi:2,psc:2,psc_management_ip:2,psc_url:2,psk:2,public_csp_url:16,public_ip:2,public_ip_pool:2,public_port:2,public_vmc_url:16,publicip:3,publish:2,publish_permiss:2,publish_statu:2,purchas:[2,3],put:3,quantiti:2,queri:[2,3],quot:2,rais:[1,2,3,4,5,6,7,8,9,10,11],rang:2,rate:2,read:2,readi:2,reason:2,reattach:3,receiv:[2,12],recent:2,recent_job_info:2,recommended_capac:2,record:[2,4],recurs:2,red:2,redirect:2,redund:3,ref:3,refer:[2,4],refresh:[3,16],refresh_token:16,refresh_url:16,region:[2,3],region_nam:2,region_to_az_to_shadow_map:2,regist:2,reject:2,relat:2,remain:2,remap:2,remot:12,remov:[2,3],removefromal:3,renam:3,repeat:2,replai:2,replay_error:2,repres:[2,12],request:[2,3,4,5,6,7,8,9,10,11,16],request_info:4,requir:[1,2,3,4,5,6,7,8,9,10,11],reserv:[2,3],reservation_id:2,reservation_schedul:2,reservation_st:2,reservation_state_cancel:2,reservation_state_complet:2,reservation_state_run:2,reservation_state_schedul:2,reservationinmw:2,reservations_cli:[0,1,2,13],reservations_mw:2,reservationschedul:2,reservationwindow:[2,3],reservationwindowmaintenanceproperti:2,reserve_id:2,reset:2,resgroup:2,resid:2,resolv:2,resourc:[2,3],resource_config:2,resource_id:2,resource_pool_moid_of_active_vs:2,resource_pool_name_of_active_vs:2,resource_typ:2,resourcepool:2,respond:2,respons:[1,2,5,12],rest:2,restrict:2,result:2,retain:2,retain_configur:2,retainconfigur:2,retreiv:3,retri:[2,16],retriev:[2,4,5,6,7,8,9,11,16],retryabl:2,reverse_proxi:2,revis:2,rid:2,rout:2,route_table_id:2,router:[2,4],rule:[2,7,8,10],rule_id:[2,7,8,10],rule_interfac:2,rule_tag:2,rule_typ:2,rule_type_default:2,rule_type_us:2,ruleid:2,run:2,rx_bytes_on_local_subnet:2,rx_bytes_on_sit:2,s3_adapt:2,s3_bucket:2,same:[2,4],saturdai:2,save_permiss:2,schedul:2,scope:[2,4],scopeinfo:2,sddc:[0,1,2,3,13],sddc_access_st:2,sddc_config:2,sddc_id:[2,3,4],sddc_manifest:2,sddc_network:[2,4],sddc_patch_request:2,sddc_public_ip_object:3,sddc_state:[2,3],sddc_state_delet:2,sddc_state_deletion_fail:2,sddc_state_deploi:2,sddc_state_fail:2,sddc_state_readi:2,sddc_template_id:2,sddc_type:2,sddcallocatepublicipspec:[2,3],sddcconfig:2,sddcconnect:3,sddcid:[2,3],sddclinkconfig:2,sddcmanifest:2,sddcnetwork:[2,4],sddcnetworkaddressgroup:2,sddcnetworkdhcpconfig:2,sddcnetworkdhcpippool:2,sddcpatchrequest:2,sddcpublicip:[2,3],sddcresourceconfig:2,sddcs_client:[0,1,2,13],sddcstaterequest:[2,3],sddctemplat:[2,3],sdk:12,search:13,seat:[2,3],second:2,secondari:2,secondary_address:2,secondary_dn:2,secondary_ip_address:2,secondaryaddress:2,secreci:2,secur:[2,16],secure_traff:2,security_context_filt:16,security_group_id:2,securitycontext:16,securitycontextfilt:16,securitygroup:2,see:[2,12],select:2,send:[2,12],sensit:7,sent:2,separ:2,seper:2,sequence_number_over_flow_error:2,serv:[2,4],server:[2,3,7,12],server_fail:2,server_statu:2,servic:[2,12,16],service_ag:2,service_aid:2,service_br:2,service_brf:2,service_certif:2,service_dn:2,service_dock:2,service_error:2,service_fm_log_collector:2,service_fm_metrics_collector:2,service_forward_proxi:2,service_glcm:2,service_info:2,service_jr:2,service_logz_log_collector:2,service_ntp:2,service_o:2,service_reverse_proxi:2,service_rt:2,service_s3_adapt:2,serviceerror:2,servicegroup:2,session:[1,2,16],sessions_cr:2,set:[1,2,3,4,7],setup:3,sha1:2,sha_256:2,shadow:2,share:2,should:[2,3,16],should_retri:16,show:[7,11],show_sensitive_data:[6,7],sign:2,sinc:[7,11,12],singl:[2,3],single_az:2,singleaz:2,site:[2,5],site_id:2,site_stat:2,site_statist:2,site_statu:2,size:[2,3,4],skip:2,skip_creating_vxlan:2,skyscrap:2,snat:2,snat_match_destination_address:2,snat_match_destination_port:2,snat_rule_id:2,softwar:2,some:2,sort:4,sort_bi:[2,4],sort_order_ascend:[2,4],sourc:[2,12],source_info:12,source_port:2,source_scop:2,source_sddc_id:2,source_srm:2,source_svc:12,source_vcent:2,source_vr:2,sourcetyp:12,space:2,spec:[3,12],special:[2,12],specif:[2,3,7,8,10],specifi:[2,3,4,5,7,8,12,16],srm:2,ssl:2,sslvpn:2,sslvpn_bytes_in:2,sslvpn_bytes_out:2,sslvpndashboardstat:2,sso:2,sso_domain:2,sss:2,stamp:2,standard:2,standbi:2,start:[2,4,7,11],start_dai:2,start_dat:2,start_day_fridai:2,start_day_mondai:2,start_day_saturdai:2,start_day_sundai:2,start_day_thursdai:2,start_day_tuesdai:2,start_day_wednesdai:2,start_hour:2,start_index:[2,4],start_resource_entity_vers:2,start_tim:[2,7,11],startindex:4,startswith:2,state:[2,3,4],state_act:2,state_appli:2,state_avail:2,state_broken:2,state_connect:2,state_delet:2,state_disconnect:2,state_fail:2,state_initi:2,state_inus:2,state_partially_connect:2,state_unknown:2,states_cancel:2,states_complet:2,states_run:2,states_schedul:2,statist:[0,1,2,3,4,5,7,9],statistics_cli:[0,1,2,3,4,5],statu:[2,5],status_activ:2,status_cancel:2,status_cr:2,status_expir:2,status_fail:2,status_finish:2,status_from_vse_updated_on:2,status_order_submit:2,status_pending_provis:2,status_start:2,std:[1,2,3,4,5,6,7,8,9,10,11],still:3,stop:2,storag:[2,3],storage_capac:2,storage_cli:[0,1,2,13],store:2,str:[1,2,3,4,5,6,7,8,9,10,11,12,16],string:[2,3,12],struct:[2,5],stub:[1,2,3,4,5,6,7,8,9,10,11,16],stub_config:[1,2,3,4,5,6,7,8,9,10,11],stubconfigur:[1,2,3,4,5,6,7,8,9,10,11],stubfactori:[1,2,3,4,5,6,7,8,9,10,11],stubfactorybas:[1,2,3,4,5,6,7,8,9,10,11],sub:2,sub_group:2,sub_interfac:2,sub_statu:2,subgroup:2,subinterfac:2,submodul:[0,13,14,15],subnet:[2,3],subnet_availability_zon:2,subnet_cidr:2,subnet_cidr_block:2,subnet_id:2,subnet_list_result:3,subnet_mask:2,subnet_prefix_length:2,subnetinfo:2,subpackag:13,subscript:2,subscription_request:2,subscriptiondetail:2,subscriptionid:2,subscriptionproduct:[2,3],subscriptionrequest:2,subscriptions_cli:[0,1,2,13],subsequ:2,substr:2,success:2,summari:[2,5],sundai:2,suppli:2,support:[2,3,12],support_window_id:2,supported_capacity_incr:2,supportwindow:[2,3],supportwindowid:[2,3],syn:2,sync:2,system:[2,12],system_statu:2,tabl:2,tag:2,take:[2,3],target:[2,3],task:[2,3,4],task_progress_phas:2,task_typ:2,task_vers:2,taskprogressphas:2,tbrs_client:[0,1,2,13],tcp:2,tcp_allow_out_of_window_packet:2,tcp_pick_ongoing_connect:2,tcp_send_reset_for_closed_vse_port:2,tcp_timeout_clos:2,tcp_timeout_establish:2,tcp_timeout_open:2,templat:[2,3,5],template_id:2,template_nam:2,templateid:5,tenant:2,tenant_id:2,tenantid:4,tend:2,term:2,termin:2,termofferinst:2,test:[2,4],test_result:4,text:[2,5],than:2,them:2,thi:[2,3,7,11,12,16],those:2,through:2,thursdai:2,time:[2,7,11],time_stamp:2,timeout:2,timestamp:2,token:16,tolow:2,total:2,total_count:2,toupper:2,tracerout:2,track:2,traffic:2,traffic_stat:2,trafficshapingpolici:2,transact:2,transfer:2,translat:[1,2],translated_address:2,translated_port:2,transmit:2,transportzon:2,triple_d:2,trunk:2,tsfp:2,tstp:2,tuesdai:2,tunnel:2,tunnel_id:2,tunnel_st:2,tunnel_stat:2,tunnel_statu:2,tunnel_status:2,tunnel_status_connect:2,tunnel_status_disconnect:2,tunnel_status_unknown:2,turn:2,two:[2,12],tx_bytes_from_local_subnet:2,tx_bytes_from_sit:2,type:[1,2,3,4,5,6,7,8,9,11,16],type_cento:2,type_connect:2,type_curl:2,type_dn:2,type_p:2,type_pop:2,type_tracerout:2,udlr:2,udp:2,udp_timeout:2,uid:2,unari:2,unauthent:[1,2,3,4,16],unauthor:[1,2,3,4,5,6,7,8,9,10,11,16],undeploi:2,under:3,undergo:2,uniqifi:2,uniqu:2,unit:2,unit_pric:2,univers:2,universal_revis:2,unknown:[2,12],unlink:2,until:[2,7,11],updat:[2,3,4,6,7,8,10],update_addon_type_hcx:4,update_ip_type_priv:4,update_ip_type_publ:4,updatecredenti:[2,4],updated_by_user_id:2,updated_by_user_nam:2,upgrad:[2,3],uplink:[2,11],upon:2,upper:2,uri:2,url:[2,16],use:[2,3,4,12,16],used:[1,2,3,4,5,6,7,8,9,10,11,16],user:[1,2,3],user_id:2,user_nam:2,usernam:2,using:[2,4,16],usual:2,utc:2,uuid:2,valid:[2,3,4,5],valu:[2,3,4,5,7,12,16],vapi:[1,2,3,4,5,6,7,8,9,10,11,12,13,14],vapiinterfac:[1,2,3,4,5,6,7,8,9,10,11],vapistruct:[2,5],vapp:2,variabl:12,vc_instance_id:2,vc_management_ip:2,vc_public_ip:2,vc_url:2,vcenter:[2,3],version:[2,12],vgw:2,vgw_route_table_id:2,via:3,view:2,view_id:2,view_match:2,view_permiss:2,vif_id:2,virtual:2,virtualmachin:2,virtualwir:2,vlan:2,vlan_id:2,vm_build_info:2,vm_moid_of_active_vs:2,vm_name_of_active_vs:2,vm_security_group_id:2,vm_version:2,vmc:[0,1,13,14,15],vmc_client:[0,13],vmc_internal_vers:2,vmc_local:1,vmc_url:16,vmc_version:2,vmcclient:16,vmcinternalvers:2,vmclocal:[1,2],vmcversion:2,vmware:[0,12],vnic0:2,vnic0_in_byt:2,vnic0_in_pkt:2,vnic0_out_byt:2,vnic0_out_pkt:2,vnic1:2,vnic1_in_byt:2,vnic1_in_pkt:2,vnic1_out_byt:2,vnic1_out_pkt:2,vnic2:2,vnic2_in_byt:2,vnic2_in_pkt:2,vnic2_out_byt:2,vnic2_out_pkt:2,vnic3:2,vnic3_in_byt:2,vnic3_in_pkt:2,vnic3_out_byt:2,vnic3_out_pkt:2,vnic4:2,vnic4_in_byt:2,vnic4_in_pkt:2,vnic4_out_byt:2,vnic4_out_pkt:2,vnic5:2,vnic5_in_byt:2,vnic5_in_pkt:2,vnic5_out_byt:2,vnic5_out_pkt:2,vnic6:2,vnic6_in_byt:2,vnic6_in_pkt:2,vnic6_out_byt:2,vnic6_out_pkt:2,vnic7:2,vnic7_in_byt:2,vnic7_in_pkt:2,vnic7_out_byt:2,vnic7_out_pkt:2,vnic8:2,vnic8_in_byt:2,vnic8_in_pkt:2,vnic8_out_byt:2,vnic8_out_pkt:2,vnic9:2,vnic9_in_byt:2,vnic9_in_pkt:2,vnic9_out_byt:2,vnic9_out_pkt:2,vnic:[2,5],vnic_:2,vnic_group_id:2,vnic_group_ids_extern:2,vnic_group_ids_intern:2,vnic_group_ids_vnic_index_0:2,vnic_group_ids_vnic_index_1:2,vnic_group_ids_vnic_index_2:2,vnic_group_ids_vnic_index_3:2,vnic_group_ids_vnic_index_4:2,vnic_group_ids_vnic_index_5:2,vnic_group_ids_vnic_index_6:2,vnic_group_ids_vnic_index_7:2,vnic_group_ids_vnic_index_8:2,vnic_group_ids_vnic_index_9:2,vnic_group_ids_vs:2,vnicindex:2,vpc:2,vpc_cidr:2,vpc_cidr_block:2,vpc_endpoint_id:2,vpc_id:2,vpc_info:2,vpc_info_peered_ag:2,vpc_map:2,vpcinfo:2,vpcinfosubnet:2,vpn:[2,5,6,7,9],vpnchannelstatu:2,vpntunnelstatu:2,vpntunneltrafficstat:2,vsan_encryption_config:2,vsanconfigconstraint:[2,3],vsanencryptionconfig:2,vsanstoragedesign:2,vse:2,vsm_uuid:2,vsphere:2,vxlan:2,vxlan_subnet:2,want:[2,12],warn:2,wednesdai:2,week:2,week_of:2,were:2,west:2,what:[2,3],when:[2,3,12],where:2,whether:[2,16],which:[1,2,3,12],white:2,who:3,why:2,win:2,window:[2,3],window_id:2,wire:2,wit:2,within:2,without:2,witness_availability_zon:2,work:[2,3],workflow:2,workload:[2,3],would:[2,12],writer:2,xml:5,yellow:2,yet:2,you:[2,3,12],your:[2,4,12],yyyi:2,zerocloud:3,zone:[2,3]},titles:["com package","com.vmware package","com.vmware.vmc package","com.vmware.vmc.orgs package","com.vmware.vmc.orgs.sddcs package","com.vmware.vmc.orgs.sddcs.networks package","com.vmware.vmc.orgs.sddcs.networks.cgws package","com.vmware.vmc.orgs.sddcs.networks.edges package","com.vmware.vmc.orgs.sddcs.networks.edges.firewall package","com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn package","com.vmware.vmc.orgs.sddcs.networks.edges.nat package","com.vmware.vmc.orgs.sddcs.networks.edges.statistics package","Interface definition language to python mapping for enumerated types","Welcome to VMware Cloud on AWS Console API\u2019s documentation!","vmware package","vmware.vapi package","vmware.vapi.vmc package"],titleterms:{AWS:13,account_link_cli:3,addons_cli:4,api:13,cgw:6,client:16,cloud:13,code:12,com:[0,1,2,3,4,5,6,7,8,9,10,11],config_cli:[8,9,10],consol:13,csp_filter:16,dashboard_cli:11,definit:12,dhcp_client:7,dns_client:[4,7],document:[12,13],edg:[7,8,9,10,11],edges_cli:5,enumer:12,exampl:12,firewal:8,firewall_cli:7,indic:13,interfac:12,interfaces_cli:11,ipsec_cli:7,l2vpn:9,l2vpn_client:6,languag:12,management_vms_cli:4,map:12,model_cli:2,modul:[1,2,3,4,5,6,7,8,9,10,11,16],nat:10,nat_client:7,network:[5,6,7,8,9,10,11],networking_cli:4,networks_cli:4,org:[3,4,5,6,7,8,9,10,11],orgs_client:2,packag:[0,1,2,3,4,5,6,7,8,9,10,11,14,15,16],python:12,reservations_cli:3,sddc:[4,5,6,7,8,9,10,11],sddcs_client:3,statist:11,statistics_cli:7,storage_cli:3,submodul:[1,2,3,4,5,6,7,8,9,10,11,16],subpackag:[0,1,2,3,4,5,7,14,15],subscriptions_cli:3,tabl:13,tbrs_client:3,type:12,vapi:[15,16],vmc:[2,3,4,5,6,7,8,9,10,11,16],vmc_client:1,vmware:[1,2,3,4,5,6,7,8,9,10,11,13,14,15,16],welcom:13}}) \ No newline at end of file diff --git a/vmc/vmware.html b/vmc/vmware.html index 437fbef5..8e71cf1a 100644 --- a/vmc/vmware.html +++ b/vmc/vmware.html @@ -8,7 +8,7 @@ -vmware package — VMware Cloud on AWS Console API 1.5.0 documentation +vmware package — VMware Cloud on AWS Console API 1.6.0 documentation @@ -60,7 +60,7 @@- 1.5.0 + 1.6.0diff --git a/vmc/vmware.vapi.html b/vmc/vmware.vapi.html index 3555d33f..0496d399 100644 --- a/vmc/vmware.vapi.html +++ b/vmc/vmware.vapi.html @@ -8,7 +8,7 @@ -vmware.vapi package — VMware Cloud on AWS Console API 1.5.0 documentation +vmware.vapi package — VMware Cloud on AWS Console API 1.6.0 documentation @@ -60,7 +60,7 @@- 1.5.0 + 1.6.0diff --git a/vmc/vmware.vapi.vmc.html b/vmc/vmware.vapi.vmc.html index 07f57e8e..82901d57 100644 --- a/vmc/vmware.vapi.vmc.html +++ b/vmc/vmware.vapi.vmc.html @@ -8,7 +8,7 @@ -vmware.vapi.vmc package — VMware Cloud on AWS Console API 1.5.0 documentation +vmware.vapi.vmc package — VMware Cloud on AWS Console API 1.6.0 documentation @@ -59,7 +59,7 @@- 1.5.0 + 1.6.0@@ -172,54 +172,56 @@@@ -228,79 +230,71 @@ is automatically created and usedvmware.vapi.vmc.client module¶
CSP Refresh token based SecurityContextFilter
+-
+
-
+
vmware.vapi.vmc.client.VmcClient(session, refresh_token, vmc_url, csp_url)¶vmware.vapi.vmc.client.create_vmc_client(refresh_token, session=None)¶ -
-class
vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter(session, refresh_token, refresh_url)¶
+class Bases:
vmware.vapi.security.client.security_context_filter.SecurityContextFilterCSP Security Context filter in API Provider chain adds the security context based on a refresh token to the execution context passed in.
Initialize SecurityContextFilter
--
+- - - Parameters: -
-
- session (
requests.Session) – Requests Session object to use for making HTTP calls
- - refresh_token (
str) – Refresh token to use for obtaining an access token
- - refresh_url (
str) – URL that allows exchanging a refresh token for an -access token
+ - Parameters +
-
+
session (
requests.Session) – Requests Session object to use for making HTTP calls
+refresh_token (
str) – Refresh token to use for obtaining an access token
+refresh_url (
str) – URL that allows exchanging a refresh token for an +access token
-
+
+- session (
-
-
get_max_retries()¶
+ Get the max number of retries
--
+- - - Return type: intReturns: Number of retries --
+
- Return type +
+int
+- Returns +
Number of retries
+
+
-
-
get_security_context(on_error)¶
+ Retrieve security context. If this method is called after an error occured, then a new access token is obtained using the refresh token and a new security context is created.
--
+- - - Parameters: on_error ( -bool) – Whether this method is called after getting an errorReturn type: vmware.vapi.core.SecurityContextReturns: Security context --
+
- Parameters +
on_error (
+bool) – Whether this method is called after getting an error
+- Return type +
+vmware.vapi.core.SecurityContext
+- Returns +
Security context
+
+
-
-
should_retry(error_value)¶
+ Returns whether the request should be retried or not based on the error specified.
--
+- - - Parameters: error_value ( -vmware.vapi.data.value.ErrorValue) – Method errorReturn type: boolReturns: Returns True if request should be retried in case the error is -either Unauthenticated or Unauthorized else False --
+
- Parameters +
error_value (
+vmware.vapi.data.value.ErrorValue) – Method error
+- Return type +
+bool
+- Returns +
Returns True if request should be retried in case the error is +either Unauthenticated or Unauthorized else False
+
+
CSP Refresh token based SecurityContextFilter
vmware.vapi.vmc.csp_filter.CSPSecurityContextFilter(session, refresh_token, refresh_url)¶get_max_retries()¶get_security_context(on_error)¶should_retry(error_value)¶
\ - Sort by:\ - best rated\ - newest\ - oldest\ -
\ -\ -
Add a comment\ - (markup):
\ -``code``, \ - code blocks:::and an indented block after blank line