diff --git a/vmc/_sources/com.vmware.vmc.orgs.sddcs.rst.txt b/vmc/_sources/com.vmware.vmc.orgs.sddcs.rst.txt index 597d3fe6..8fba8ba4 100644 --- a/vmc/_sources/com.vmware.vmc.orgs.sddcs.rst.txt +++ b/vmc/_sources/com.vmware.vmc.orgs.sddcs.rst.txt @@ -32,6 +32,14 @@ com.vmware.vmc.orgs.sddcs.dns\_client module :undoc-members: :show-inheritance: +com.vmware.vmc.orgs.sddcs.management\_vms\_client module +-------------------------------------------------------- + +.. automodule:: com.vmware.vmc.orgs.sddcs.management_vms_client + :members: + :undoc-members: + :show-inheritance: + com.vmware.vmc.orgs.sddcs.networking\_client module --------------------------------------------------- diff --git a/vmc/_sources/index.rst.txt b/vmc/_sources/index.rst.txt index f2604494..1a8db33f 100644 --- a/vmc/_sources/index.rst.txt +++ b/vmc/_sources/index.rst.txt @@ -1,5 +1,5 @@ .. VMware Cloud on AWS Console API documentation master file, created by - sphinx-quickstart on Wed May 29 10:00:45 2019. + sphinx-quickstart on Tue Jun 4 12:24:36 2019. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/vmc/_static/ajax-loader.gif b/vmc/_static/ajax-loader.gif new file mode 100644 index 00000000..61faf8ca Binary files /dev/null and b/vmc/_static/ajax-loader.gif differ diff --git a/vmc/_static/basic.css b/vmc/_static/basic.css index 53acd096..0807176e 100644 --- a/vmc/_static/basic.css +++ b/vmc/_static/basic.css @@ -231,16 +231,6 @@ a.headerlink { visibility: hidden; } -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, @@ -401,16 +391,6 @@ table.citation td { border-bottom: none; } -th > p:first-child, -td > p:first-child { - margin-top: 0px; -} - -th > p:last-child, -td > p:last-child { - margin-bottom: 0px; -} - /* -- figures --------------------------------------------------------------- */ div.figure { @@ -480,57 +460,11 @@ ol.upperroman { list-style: upper-roman; } -li > p:first-child { - margin-top: 0px; -} - -li > p:last-child { - margin-bottom: 0px; -} - -dl.footnote > dt, -dl.citation > dt { - float: left; -} - -dl.footnote > dd, -dl.citation > dd { - margin-bottom: 0em; -} - -dl.footnote > dd:after, -dl.citation > dd:after { - content: ""; - clear: both; -} - -dl.field-list { - display: flex; - flex-wrap: wrap; -} - -dl.field-list > dt { - flex-basis: 20%; - font-weight: bold; - word-break: break-word; -} - -dl.field-list > dt:after { - content: ":"; -} - -dl.field-list > dd { - flex-basis: 70%; - padding-left: 1em; - margin-left: 0em; - margin-bottom: 0em; -} - dl { margin-bottom: 15px; } -dd > p:first-child { +dd p { margin-top: 0px; } @@ -603,12 +537,6 @@ dl.glossary dt { font-style: oblique; } -.classifier:before { - font-style: normal; - margin: 0.5em; - content: ":"; -} - abbr, acronym { border-bottom: dotted 1px; cursor: help; diff --git a/vmc/_static/comment-bright.png b/vmc/_static/comment-bright.png new file mode 100644 index 00000000..15e27edb Binary files /dev/null and b/vmc/_static/comment-bright.png differ diff --git a/vmc/_static/comment-close.png b/vmc/_static/comment-close.png new file mode 100644 index 00000000..4d91bcf5 Binary files /dev/null and b/vmc/_static/comment-close.png differ diff --git a/vmc/_static/comment.png b/vmc/_static/comment.png new file mode 100644 index 00000000..dfbc0cbd Binary files /dev/null and b/vmc/_static/comment.png differ diff --git a/vmc/_static/doctools.js b/vmc/_static/doctools.js index b33f87fc..344db17d 100644 --- a/vmc/_static/doctools.js +++ b/vmc/_static/doctools.js @@ -87,13 +87,14 @@ jQuery.fn.highlightText = function(text, className) { node.nextSibling)); node.nodeValue = val.substr(0, pos); if (isInSVG) { + var bbox = span.getBBox(); var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - var bbox = node.parentElement.getBBox(); - rect.x.baseVal.value = bbox.x; + rect.x.baseVal.value = bbox.x; rect.y.baseVal.value = bbox.y; rect.width.baseVal.value = bbox.width; rect.height.baseVal.value = bbox.height; rect.setAttribute('class', className); + var parentOfText = node.parentNode.parentNode; addItems.push({ "parent": node.parentNode, "target": rect}); diff --git a/vmc/_static/documentation_options.js b/vmc/_static/documentation_options.js index 1202b357..093f6aa1 100644 --- a/vmc/_static/documentation_options.js +++ b/vmc/_static/documentation_options.js @@ -1,10 +1,10 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '1.4.0', + VERSION: '1.5.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false + NAVIGATION_WITH_KEYS: false, }; \ No newline at end of file diff --git a/vmc/_static/down-pressed.png b/vmc/_static/down-pressed.png new file mode 100644 index 00000000..5756c8ca Binary files /dev/null and b/vmc/_static/down-pressed.png differ diff --git a/vmc/_static/down.png b/vmc/_static/down.png new file mode 100644 index 00000000..1b3bdad2 Binary files /dev/null and b/vmc/_static/down.png differ diff --git a/vmc/_static/searchtools.js b/vmc/_static/searchtools.js index bdc27065..5ff31806 100644 --- a/vmc/_static/searchtools.js +++ b/vmc/_static/searchtools.js @@ -36,10 +36,8 @@ if (!Scorer) { // query found in title title: 15, - partialTitle: 7, // query found in terms - term: 5, - partialTerm: 2 + term: 5 }; } @@ -58,14 +56,6 @@ var Search = { _queued_query : null, _pulse_status : -1, - htmlToText : function(htmlString) { - var htmlElement = document.createElement('span'); - htmlElement.innerHTML = htmlString; - $(htmlElement).find('.headerlink').remove(); - docContent = $(htmlElement).find('[role=main]')[0]; - return docContent.textContent || docContent.innerText; - }, - init : function() { var params = $.getQueryParameters(); if (params.q) { @@ -130,7 +120,7 @@ var Search = { this.out = $('#search-results'); this.title = $('
').appendTo(this.out); + this.status = $('').appendTo(this.out); this.output = $('
\ + <%username%>\ + \ + <%time.delta%>\ +
\ +\ + reply ▿\ + proposal ▹\ + \ + \ + \ +
\ + \ +\ +<#proposal_diff#>\ +\ +
com.vmware.vmc_client.
Locale
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-vmc_locale (com.vmware.vmc.model_client.VmcLocale
) – The locale to be set. (required)
com.vmware.vmc.model.VmcLocale
-com.vmware.vapi.std.errors_client.Unauthenticated
-Unauthorized
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: | com.vmware.vmc.model_client.VmcLocale |
+
Returns: | com.vmware.vmc.model.VmcLocale | +
Raise: | com.vmware.vapi.std.errors_client.Unauthenticated
+Unauthorized |
+
Raise: | com.vmware.vapi.std.errors_client.Unauthorized
+Forbidden |
+
com.vmware.vmc_client.
Orgs
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
com.vmware.vmc.model.Organization
-com.vmware.vapi.std.errors_client.Unauthenticated
-Unauthorized
com.vmware.vapi.std.errors_client.Unauthorized
-Forbidden
com.vmware.vapi.std.errors_client.NotFound
-Organization doesn’t exist
Parameters: | org (str ) – Organization identifier. (required) |
+
---|---|
Return type: | com.vmware.vmc.model_client.Organization |
+
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 |
+
list
()¶
Return a list of all organizations the calling user (based on credential) is authorized on.
-com.vmware.vapi.std.errors_client.Unauthenticated
-Unauthorized
com.vmware.vapi.std.errors_client.Unauthorized
-Forbidden
Return type: | list of com.vmware.vmc.model_client.Organization |
+
---|---|
Returns: | + |
Raise: | com.vmware.vapi.std.errors_client.Unauthenticated
+Unauthorized |
+
Raise: | com.vmware.vapi.std.errors_client.Unauthorized
+Forbidden |
+
com.vmware.vmc_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
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)¶
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.
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 (str
or None
) – 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: |
|
+
---|
com.vmware.vmc.model_client.
AccountLinkConfig
(delay_account_link=None)¶
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.
delay_account_link (bool
or None
) – Boolean flag identifying whether account linking should be delayed
-or not for the SDDC.
Parameters: | delay_account_link (bool or None ) – Boolean flag identifying whether account linking should be delayed
+or not for the SDDC. |
+
---|
com.vmware.vmc.model_client.
AccountLinkSddcConfig
(customer_subnet_ids=None, connected_account_id=None)¶
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.
customer_subnet_ids (list
of str
or None
) –
connected_account_id (str
or None
) – The ID of the customer connected account to work with.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Source 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.
exclude (bool
or None
) – Exclude the specified source or destination.
ip_address (list
of str
or None
) – List of string. Can specify single IP address, range of IP address,
-or in CIDR format. Can define multiple.
grouping_object_id (list
of str
or None
) – List of string. Id of cluster, datacenter, distributedPortGroup,
+
Parameters: |
|
+
---|
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)¶
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.
cert_enabled (bool
or None
) – Boolean flag to indicate if the agent is using CA signed
-certificate
internal_ip (str
or None
) – Internal IP address of the agent
hostname_verifier_enabled (bool
or None
) – Boolean flag to indicate if the agent is using FQDN in the
-certificate
network_netmask (str
or None
) – Network netmask of the agent
network_gateway (str
or None
) – Network gateway of the agent
provider (str
) – The cloud provider
is_master (bool
or None
) – Boolean flag to indicate if the agent is the master, only the
-master Agent is accessible
agent_state (str
or None
) –
Possible values are:
+Parameters: |
Agent state
+
+ |
+
---|
AGENT_STATE_CUSTOMIZING
= 'CUSTOMIZING'¶Bases: vmware.vapi.bindings.struct.VapiStruct
the 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.
region (str
or None
) – the region of the esx ami
id (str
or None
) – the ami id for the esx
name (str
or None
) – the name of the esx ami
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
NSX 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.
data_store_moid_of_active_vse (str
or None
) – vCenter MOID of the active NSX Edge appliance’s data store.
enable_fips (bool
or None
) – Value is true if FIPS is enabled on NSX Edge appliance.
host_name_of_active_vse (str
or None
) – Host name of the active NSX Edge appliance.
vm_build_info (str
or None
) – NSX Edge appliance build version.
deploy_appliances (bool
or None
) – Value is true if NSX Edge appliances are to be deployed.
communication_channel (str
or None
) – Communication channel used to communicate with NSX Edge appliance.
vm_name_of_active_vse (str
or None
) – Name of the active NSX Edge appliance.
number_of_deployed_vms (long
or None
) – Number of deployed appliances of the NSX Edge. format: int32
resource_pool_moid_of_active_vse (str
or None
) – vCenter MOID of the active NSX Edge appliance’s resource
+
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Application 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.
application_id (list
of str
or None
) – List of string. Id of service or serviceGroup groupingObject. Can
-define multiple.
service (list
of Nsxfirewallservice
or None
) – List of protocol and ports. Can define multiple.
Parameters: |
|
+
---|
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)¶
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.
instance_id (str
or None
) –
key_pair (AwsKeyPair
or None
) –
cert_enabled (bool
or None
) – Boolean flag to indicate if the agent is using CA signed
-certificate
internal_ip (str
or None
) – Internal IP address of the agent
hostname_verifier_enabled (bool
or None
) – Boolean flag to indicate if the agent is using FQDN in the
-certificate
network_netmask (str
or None
) – Network netmask of the agent
network_gateway (str
or None
) – Network gateway of the agent
provider (str
) – The cloud provider
is_master (bool
or None
) – Boolean flag to indicate if the agent is the master, only the
-master Agent is accessible
agent_state (str
or None
) –
Possible values are:
+Parameters: |
Agent state
+
+ |
+
---|
provider
¶com.vmware.vmc.model_client.
AwsCloudProvider
(regions=None, provider='AWS')¶
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.
regions (list
of str
or None
) –
provider (str
) – Name of the Cloud Provider
Parameters: |
|
+
---|
provider
¶com.vmware.vmc.model_client.
AwsCompatibleSubnets
(customer_available_zones=None, vpc_map=None)¶
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.
customer_available_zones (list
of str
or None
) –
vpc_map ((dict
of str
and VpcInfoSubnets
) or None
) –
Parameters: |
|
+
---|
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)¶
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.
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 (str
or None
) – 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 (str
or None
) –
region_to_az_to_shadow_mapping ((dict
of str
and (dict
of str
and str
)) or None
) – Provides a map of regions to availability zones from the shadow
-account’s perspective
org_id (str
or None
) –
cf_stack_name (str
or None
) –
state (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
STATE_ACTIVE
= 'ACTIVE'¶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)¶
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.
internal_public_ip_pool (list
of SddcPublicIp
or None
) –
name (str
or None
) –
availability_zone (str
or None
) – Availability zone where the host is provisioned.
esx_id (str
or None
) –
hostname (str
or None
) –
provider (str
) –
mac_address (str
or None
) –
custom_properties ((dict
of str
and str
) or None
) –
esx_state (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
provider
¶com.vmware.vmc.model_client.
AwsKeyPair
(key_name=None, key_fingerprint=None, key_material=None)¶
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.
key_name (str
or None
) –
key_fingerprint (str
or None
) –
key_material (str
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
AwsKmsInfo
(amazon_resource_name=None)¶
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.
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.
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)¶
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.
region (str
) –
storage_capacity (long
or None
) – The storage capacity value to be requested for the sddc primary
+
Parameters: |
|
+
---|
provider
¶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)¶
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.
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 (str
or None
) – 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 (str
or None
) – The CIDR block of the customer’s subnet this link is in.
connected_account_id (str
or None
) – The corresponding connected (customer) account UUID this connection
-is attached to.
eni_group (str
or None
) – Which group the ENIs belongs to. (deprecated)
subnet_id (str
or None
) – The ID of the subnet this link is to.
cgw_present (bool
or None
) – Determines whether the CGW is present in this connection set or
-not. Used for multi-az deployments.
org_id (str
or None
) – The org this link belongs to.
sddc_id (str
or None
) – The SDDC this link is used for.
cidr_block_vpc (str
or None
) – The CIDR block of the customer’s VPC.
connection_order (long
or None
) – The order of the connection
state (str
or None
) –
Possible values are:
+Parameters: |
The state of the connection.
+
+ |
+
---|
STATE_ACTIVE
= 'ACTIVE'¶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)¶
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.
backup_restore_bucket (str
or None
) –
public_ip_pool (list
of SddcPublicIp
or None
) –
vpc_info (VpcInfo
or None
) –
kms_vpc_endpoint (KmsVpcEndpoint
or None
) –
max_num_public_ip (long
or None
) – maximum number of public IP that user can allocate.
account_link_sddc_config (list
of SddcLinkConfig
or None
) –
region (str
or None
) –
vsan_encryption_config (VsanEncryptionConfig
or None
) –
vpc_info_peered_agent (VpcInfo
or None
) –
mgmt_appliance_network_name (str
or None
) – Name for management appliance network.
nsxt (bool
or None
) – if true, NSX-T UI is enabled.
mgw_id (str
or None
) – Management Gateway Id
nsx_mgr_url (str
or None
) – URL of the NSX Manager
psc_management_ip (str
or None
) – PSC internal management IP
psc_url (str
or None
) – URL of the PSC server
cgws (list
of str
or None
) –
availability_zones (list
of str
or None
) – Availability zones over which esx hosts are provisioned. MultiAZ
+
Parameters: |
Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.
+
+ |
+
---|
provider
¶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)¶
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.
connected_account_id (str
or None
) – The connected account ID this subnet is accessible through. This is
-an internal ID formatted as a UUID specific to Skyscraper.
region_name (str
or None
) – The region this subnet is in, usually in the form of country code,
-general location, and a number (ex. us-west-2).
availability_zone (str
or None
) – The availability zone this subnet is in, which should be the region
-name plus one extra letter (ex. us-west-2a).
subnet_id (str
or None
) – The subnet ID in AWS, provided in the form ‘subnet-######’.
subnet_cidr_block (str
or None
) – The CIDR block of the subnet, in the form of ‘#.#.#.#/#’.
is_compatible (bool
or None
) – Flag indicating whether this subnet is compatible. If true, this is
-a valid choice for the customer to deploy a SDDC in.
vpc_id (str
or None
) – The VPC ID the subnet resides in within AWS. Tends to be
-‘vpc-#######’.
vpc_cidr_block (str
or None
) – The CIDR block of the VPC, in the form of ‘#.#.#.#/#’.
name (str
or None
) – Optional field (may not be provided by AWS), indicates the found
-name tag for the subnet.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
CA 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.
ca_certificate (list
of str
or None
) –
Parameters: | ca_certificate (list of str or None ) – |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Statistics 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.
vnic (long
or None
) – Vnic index. format: int32
timestamp (long
or None
) – Timestamp value. format: int64
out (float
or None
) – Tx rate (Kilobits per second - kbps) format: double
in (float
or None
) – Rx rate (Kilobits per second - kbps) format: double
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
NSX 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.
data_dto (CbmStatsData
or None
) – Statistics data.
meta_dto (MetaDashboardStats
or None
) – Start time, end time and interval details.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
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.
vnic9 (list
of CbmStatistic
or None
) –
vnic8 (list
of CbmStatistic
or None
) –
vnic7 (list
of CbmStatistic
or None
) –
vnic6 (list
of CbmStatistic
or None
) –
vnic5 (list
of CbmStatistic
or None
) –
vnic4 (list
of CbmStatistic
or None
) –
vnic3 (list
of CbmStatistic
or None
) –
vnic2 (list
of CbmStatistic
or None
) –
vnic1 (list
of CbmStatistic
or None
) –
vnic0 (list
of CbmStatistic
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
CloudProvider
(provider='CloudProvider')¶
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.
provider (str
) – Name of the Cloud Provider
Parameters: | provider (str ) – Name of the Cloud Provider |
+
---|
provider
¶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)¶
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.
esx_host_list (list
of AwsEsxHost
or None
) –
cluster_state (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
CLUSTER_STATE_ADDING_HOSTS
= 'ADDING_HOSTS'¶com.vmware.vmc.model_client.
ClusterConfig
(host_cpu_cores_count=None, storage_capacity=None, num_hosts=None)¶
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.
host_cpu_cores_count (long
or None
) – Customize CPU cores on hosts in a cluster. Specify number of cores
-to be enabled on hosts in a cluster. format: int32
storage_capacity (long
or None
) – For EBS-backed instances only, the requested storage capacity in
-GiB. format: int64
num_hosts (long
) –
Parameters: |
|
+
---|
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)¶
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.
public_ip (SddcPublicIp
or None
) –
primary_dns (str
or None
) –
secondary_dns (str
or None
) –
firewall_rules (list
of FirewallRule
or None
) –
vpns (list
of Vpn
or None
) –
logical_networks (list
of LogicalNetwork
or None
) –
nat_rules (list
of NatRule
or None
) –
l2_vpn (vmware.vapi.struct.VapiStruct
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
ConnectivityAgentValidation
(source=None, type=None, ports=None, path=None)¶
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.
source (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
SOURCE_SRM
= 'SRM'¶com.vmware.vmc.model_client.
ConnectivityValidationGroup
(id=None, name=None, sub_groups=None)¶
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.
id (str
or None
) –
Possible values are:
+Parameters: |
test group id, currently, only HLM.
+
+ |
+
---|
ID_DRAAS
= 'DRAAS'¶com.vmware.vmc.model_client.
ConnectivityValidationGroups
(groups=None)¶
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.
groups (list
of ConnectivityValidationGroup
or None
) – List of groups.
Parameters: | groups (list of ConnectivityValidationGroup or None ) – List of groups. |
+
---|
com.vmware.vmc.model_client.
ConnectivityValidationInput
(id=None, value=None, label=None)¶
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.
id (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
ID_HOSTNAME
= 'HOSTNAME'¶com.vmware.vmc.model_client.
ConnectivityValidationSubGroup
(inputs=None, tests=None, label=None, help=None, id=None)¶
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.
inputs (list
of ConnectivityValidationInput
or None
) – List of user inputs for the sub group.
tests (list
of ConnectivityAgentValidation
or None
) – List of connectivity tests.
label (str
or None
) – Name of the sub-group.
help (str
or None
) – Help text.
id (str
or None
) –
Possible values are:
+ID_ACTIVE_DIRECTORY
= 'ACTIVE_DIRECTORY'¶Bases: vmware.vapi.bindings.struct.VapiStruct
CRL 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.
crl_certificate (list
of str
or None
) –
Parameters: | crl_certificate (list of str or None ) – |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Indicates 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.
secondary_ip_addresses (list
of str
or None
) – Indicates list of secondary IP created for this ENI.
eni_id (str
or None
) – Interface ID on customer account.
primary_ip_address (str
or None
) – Indicates primary address of the ENI.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Dashboard 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.
firewall (FirewallDashboardStats
or None
) – NSX Edge Firewall Statistics data.
sslvpn (SslvpnDashboardStats
or None
) – NSX Edge SSL VPN Statistics data.
interfaces (InterfacesDashboardStats
or None
) – NSX Edge Interface Statistics data.
load_balancer (LoadBalancerDashboardStats
or None
) – NSX Edge Load Balancer Statistics data.
ipsec (IpsecDashboardStats
or None
) – NSX Edge Ipsec Statistics data.
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
DashboardStat
(timestamp=None, value=None)¶
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.
timestamp (long
or None
) –
value (float
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Dashboard 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.
data_dto (DashboardData
or None
) – Dashboard Statistics data.
meta_dto (MetaDashboardStats
or None
) – Start time, end time and interval details.
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
DataPageEdgeSummary
(paging_info=None, data=None)¶
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.
paging_info (PagingInfo
or None
) –
data (list
of EdgeSummary
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
DataPageSddcNetwork
(paging_info=None, data=None)¶
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.
paging_info (PagingInfo
or None
) –
data (list
of SddcNetwork
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
DataPermissions
(save_permission=None, publish_permission=None)¶
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.
save_permission (bool
or None
) –
publish_permission (bool
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DHCP 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.
host_lease_info_dtos (list
of HostLeaseInfo
or None
) – List of DHCP leases.
Parameters: | host_lease_info_dtos (list of HostLeaseInfo or None ) – List of DHCP leases. |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DHCP 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.
time_stamp (long
or None
) – The timestamp of the DHCP lease. format: int64
host_lease_infos_dto (DhcpLeaseInfo
or None
) – DHCP lease information.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DNS 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.
feature_type (str
or None
) –
logging (Logging
or None
) – DNS logging setting.
enabled (bool
or None
) – Value is true if feature is enabled. Default value is true.
-Optional.
dns_views (DnsViews
or None
) – List of DNS views.
listeners (DnsListeners
or None
) – List of DNS listeners.
version (long
or None
) – Version number tracking each configuration change. To avoid
+
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DNS 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.
ip_address (list
of str
or None
) – IP addresses of the DNS servers.
Parameters: | ip_address (list of str or None ) – IP addresses of the DNS servers. |
+
---|
com.vmware.vmc.model_client.
DnsListeners
(ip_address=None, vnic=None, type=None)¶
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.
ip_address (list
of str
or None
) – List of IP addresses.
vnic (list
of str
or None
) – Vnic for DNS listener.
type (str
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DNS 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.
total (long
or None
) –
form_err (long
or None
) –
nx_domain (long
or None
) –
success (long
or None
) –
server_fail (long
or None
) –
nxrrset (long
or None
) –
others (long
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DNS 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.
time_stamp (long
or None
) –
requests (Requests
or None
) –
responses (DnsResponseStats
or None
) –
cached_dbrr_set (long
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DNS 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.
name (str
) – Name of the DNS view.
view_match (DnsViewMatch
or None
) – Rules that match the DNS query to this view. The rule can be
-ipAddress, or ipSet. Defaults to ipAddress ‘any’ and ‘any’ vnic.
recursion (bool
or None
) – Recursion enabled on DNS view.
view_id (str
or None
) – Identifier for the DNS view.
forwarders (DnsForwarders
or None
) – DNS forwarders.
enabled (bool
or None
) – DNS view is enabled.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Dns 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.
vnic (list
of str
or None
) –
ip_set (list
of str
or None
) –
ip_address (list
of str
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DNS 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.
dns_view (list
of DnsView
or None
) – List of DNS views.
Parameters: | dns_view (list of DnsView or None ) – List of DNS views. |
+
---|
Job 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.
status (str
or None
) – Job status.
edge_id (str
or None
) – NSX Edge ID.
module (str
or None
) – Module information.
job_id (str
or None
) – Job ID.
error_code (str
or None
) – Error code identifying the failure of the configuration change.
result (list
of Result
or None
) – Job result information.
start_time (datetime.datetime
or None
) – Job start time. format: date-time
message (str
or None
) – Job message.
end_time (datetime.datetime
or None
) – Job end time. format: date-time
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
NSX 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.
pre_rules_exists (bool
or None
) – Value is true if pre rules publish is enabled.
feature_statuses (list
of FeatureStatus
or None
) – Individual feature status.
timestamp (long
or None
) – Timestamp value at which the NSX Edge healthcheck was done. format:
-int64
publish_status (str
or None
) – 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 (long
or None
) – Value of the last published pre rules generation number. format:
-int64
version (long
or None
) – Version number of the current configuration. format: int64
edge_vm_status (list
of EdgeVmStatus
or None
) – Detailed status of each of the deployed NSX Edge appliances.
active_vse_ha_index (long
or None
) – Index of the active NSX Edge appliance. Values are 0 and 1. format:
-int32
system_status (str
or None
) – System status of the active NSX Edge appliance.
ha_vnic_in_use (long
or None
) – Index of the vnic consumed for NSX Edge HA. format: int32
edge_status (str
or None
) – NSX Edge appliance health status identified by GREY (unknown
+
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
NSX 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.
feature_capabilities (FeatureCapabilities
or None
) – List of Features and their capability details based on Edge
-appliance form factor.
edge_type (str
or None
) – NSX Edge type, whether ‘gatewayServices’ or ‘distributedRouter’.
logical_router_scopes (LogicalRouterScopes
or None
) – Backing type scope (DistributedVirtualSwitch - VLAN, TransportZone
--VXLAN) and its ID for the Distributed Logical Router.
recent_job_info (EdgeJob
or None
) – Job information for the most recent configuration change carried
-out on the NSX Edge.
hypervisor_assist (bool
or None
) –
edge_assist_id (long
or None
) – ID generated by NSX Manager for Distributed Logical Router only.
-format: int64
edge_status (str
or None
) – NSX Edge appliance health status identified by GREY (unknown
+
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Status 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.
index (long
or None
) – High Availability index of the appliance. Values are 0 and 1.
-format: int32
ha_state (str
or None
) – High Availability state of the appliance. Values are active and
-standby.
name (str
or None
) – Name of the NSX Edge appliance.
id (str
or None
) – vCenter MOID of the NSX Edge appliance.
edge_vm_status (str
or None
) – NSX Edge appliance health status identified by GREY (unknown
+
Parameters: |
|
+
---|
Address 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.
subnet_prefix_length (str
or None
) – Subnet prefix length of the primary IP address.
secondary_addresses (SecondaryAddresses
or None
) – Secondary IP addresses of the NSX Edge vnic address group.
-Optional.
primary_address (str
or None
) – Primary IP address of the vnic interface. Required.
subnet_mask (str
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
NSX 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.
address_groups (list
of EdgeVnicAddressGroup
or None
) – Address group configuration of the NSX Edge vnic. Vnic can be
-configured to have more than one address group/subnets.
Parameters: | address_groups (list of EdgeVnicAddressGroup or None ) – 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.
EniInfo
(subnet_id=None, id=None, security_group_id=None, private_ip=None, mac_address=None)¶
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.
subnet_id (str
or None
) – Subnet it belongs to.
id (str
or None
) – Interface ID.
security_group_id (str
or None
) – Security Group of Eni.
private_ip (str
or None
) – Private ip of eni.
mac_address (str
or None
) – Mac address of nic.
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
ErrorResponse
(status=None, path=None, retryable=None, error_code=None, error_messages=None)¶
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.
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 (list
of str
) – localized error messages
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
EsxConfig
(availability_zone=None, esxs=None, cluster_id=None, num_hosts=None)¶
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.
availability_zone (str
or None
) – Availability zone where the hosts should be provisioned. (Can be
-specified only for privileged host operations).
esxs (list
of str
or None
) –
cluster_id (str
or None
) – An optional cluster id if the esxs operation has to be on a
-specific cluster.
num_hosts (long
) –
Parameters: |
|
+
---|
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)¶
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.
name (str
or None
) –
availability_zone (str
or None
) – Availability zone where the host is provisioned.
esx_id (str
or None
) –
hostname (str
or None
) –
provider (str
) –
mac_address (str
or None
) –
custom_properties ((dict
of str
and str
) or None
) –
esx_state (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
ESX_STATE_DELETED
= 'DELETED'¶com.vmware.vmc.model_client.
ExtendedAttribute
(name=None, value=None)¶
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.
name (str
or None
) –
value (str
or None
) –
Parameters: |
|
+
---|
List 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.
timestamp (long
or None
) – Time stamp value at which the feature capabilities were retrieved.
-format: int64
feature_capabilities (list
of FeatureCapability
or None
) – List of feature capability information.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Feature 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.
configuration_limits (list
of KeyValueAttributes
or None
) – List of key value pairs describing the feature configuration
-limits.
is_supported (bool
or None
) – Value is true if feature is supported on NSX Edge.
service (str
or None
) – Name of the feature or service.
permission (LicenceAclPermissions
or None
) – Licence and access control information for the feature.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Individual 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.
status (str
or None
) – Status of the feature or service.
configured (bool
or None
) – Value is true if feature is configured.
server_status (str
or None
) – Server status of the feature or service. Values are up and down.
publish_status (str
or None
) – Publish status of the feature, whether APPLIED or PERSISTED.
service (str
or None
) – Name of the feature or service.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Firewall 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.
firewall_rules (FirewallRules
or None
) – Ordered list of firewall rules.
feature_type (str
or None
) –
version (long
or None
) – Version number tracking each configuration change. To avoid
+
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Dashboard 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.
connections (list
of DashboardStat
or None
) – Number of NSX Edge firewall connections and rules.
Parameters: | connections (list of DashboardStat or None ) – Number of NSX Edge firewall connections and rules. |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Firewall 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.
action (str
or None
) – Action. Default is deny. Supported values accept, deny
logging_enabled (bool
or None
) – Enable logging for the rule.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Global 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.
tcp_allow_out_of_window_packets (bool
or None
) – Allow TCP out of window packets.
udp_timeout (long
or None
) – UDP timeout close. format: int32
ip_generic_timeout (long
or None
) – IP generic timeout. format: int32
tcp_pick_ongoing_connections (bool
or None
) – Pick TCP ongoing connections.
tcp_timeout_open (long
or None
) – TCP timeout open. format: int32
tcp_timeout_close (long
or None
) – TCP timeout close. format: int32
icmp6_timeout (long
or None
) – ICMP6 timeout. format: int32
drop_icmp_replays (bool
or None
) – Drop icmp replays.
log_icmp_errors (bool
or None
) – Log icmp errors.
tcp_send_reset_for_closed_vse_ports (bool
or None
) – Send TCP reset for closed NSX Edge ports.
drop_invalid_traffic (bool
or None
) – Drop invalid traffic.
enable_syn_flood_protection (bool
or None
) – Protect against SYN flood attacks by detecting bogus TCP
+
Parameters: |
|
+
---|
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)¶
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.
rule_type (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
ACTION_ALLOW
= 'ALLOW'¶Bases: vmware.vapi.bindings.struct.VapiStruct
Optional 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.
grouping_object_ids (list
of str
or None
) –
vnic_group_ids (list
of str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
VNIC_GROUP_IDS_EXTERNAL
= 'external'¶Bases: vmware.vapi.bindings.struct.VapiStruct
Statistics 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.
timestamp (long
or None
) – Timestamp of statistics collection. format: int64
connection_count (long
or None
) – Connection count. format: int64
byte_count (long
or None
) – Byte count. format: int64
packet_count (long
or None
) – Packet count. format: int64
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Ordered 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.
firewall_rules (list
of Nsxfirewallrule
or None
) – Ordered list of firewall rules.
Parameters: | firewall_rules (list of Nsxfirewallrule or None ) – Ordered list of firewall rules. |
+
---|
com.vmware.vmc.model_client.
FirewallService
(protocol=None, ports=None)¶
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.
protocol (str
or None
) – protocol name, such as ‘tcp’, ‘udp’ etc.
ports (list
of str
or None
) – a list of port numbers and port ranges, such as {80, 91-95, 99}. If
-not specified, defaults to ‘any’.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Describes 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.
public_ip (SddcPublicIp
or None
) –
primary_dns (str
or None
) –
secondary_dns (str
or None
) –
firewall_rules (list
of FirewallRule
or None
) –
vpns (list
of Vpn
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
the 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.
s3_bucket (str
or None
) – the glcmbundle’s s3 bucket
id (str
or None
) – the glcmbundle’s id
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DHCP 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.
mac_address (str
or None
) – MAC address of the client.
ends (str
or None
) – End time of the lease.
abandoned (str
or None
) – Time stamp of when IP address was marked as abandoned.
cltt (str
or None
) – Client Last Transaction Time of the lease info.
client_hostname (str
or None
) – Name of the client.
starts (str
or None
) – Start time of the lease.
binding_state (str
or None
) – Lease’s binding state.
hardware_type (str
or None
) – The hardware type on which the lease will be used.
tsfp (str
or None
) – Time Sent From Partner of the lease info.
uid (str
or None
) – Uid to identify the DHCP lease.
next_binding_state (str
or None
) – Indicates what state the lease will move to when the current state
-expires.
ip_address (str
or None
) – IP address of the client.
tstp (str
or None
) – Time Sent To Partner of the lease info.
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
InteractionPermissions
(manage_permission=None, view_permission=None)¶
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.
manage_permission (bool
or None
) –
view_permission (bool
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Dashboard 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.
vnic7_in_pkt (list
of DashboardStat
or None
) –
vnic0_in_byte (list
of DashboardStat
or None
) –
vnic8_out_pkt (list
of DashboardStat
or None
) –
vnic5_in_byte (list
of DashboardStat
or None
) –
vnic2_in_pkt (list
of DashboardStat
or None
) –
vnic3_in_pkt (list
of DashboardStat
or None
) –
vnic6_out_byte (list
of DashboardStat
or None
) –
vnic3_in_byte (list
of DashboardStat
or None
) –
vnic8_in_pkt (list
of DashboardStat
or None
) –
vnic1_in_byte (list
of DashboardStat
or None
) –
vnic1_out_pkt (list
of DashboardStat
or None
) –
vnic5_out_byte (list
of DashboardStat
or None
) –
vnic0_out_pkt (list
of DashboardStat
or None
) –
vnic0_out_byte (list
of DashboardStat
or None
) –
vnic6_out_pkt (list
of DashboardStat
or None
) –
vnic3_out_byte (list
of DashboardStat
or None
) –
vnic7_in_byte (list
of DashboardStat
or None
) –
vnic1_out_byte (list
of DashboardStat
or None
) –
vnic9_out_pkt (list
of DashboardStat
or None
) –
vnic9_in_pkt (list
of DashboardStat
or None
) –
vnic4_in_byte (list
of DashboardStat
or None
) –
vnic5_out_pkt (list
of DashboardStat
or None
) –
vnic2_out_pkt (list
of DashboardStat
or None
) –
vnic2_in_byte (list
of DashboardStat
or None
) –
vnic5_in_pkt (list
of DashboardStat
or None
) –
vnic7_out_pkt (list
of DashboardStat
or None
) –
vnic3_out_pkt (list
of DashboardStat
or None
) –
vnic4_out_pkt (list
of DashboardStat
or None
) –
vnic4_out_byte (list
of DashboardStat
or None
) –
vnic1_in_pkt (list
of DashboardStat
or None
) –
vnic2_out_byte (list
of DashboardStat
or None
) –
vnic6_in_byte (list
of DashboardStat
or None
) –
vnic0_in_pkt (list
of DashboardStat
or None
) –
vnic9_in_byte (list
of DashboardStat
or None
) –
vnic7_out_byte (list
of DashboardStat
or None
) –
vnic4_in_pkt (list
of DashboardStat
or None
) –
vnic9_out_byte (list
of DashboardStat
or None
) –
vnic8_out_byte (list
of DashboardStat
or None
) –
vnic8_in_byte (list
of DashboardStat
or None
) –
vnic6_in_pkt (list
of DashboardStat
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
IP 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.
ip_address (list
of str
or None
) – List of IP addresses.
Parameters: | ip_address (list of str or None ) – List of IP addresses. |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
NSX 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.
feature_type (str
or None
) –
logging (Logging
or None
) – Configure logging for the feature on NSX Edge appliance. Logging is
-disabled by default. Optional.
global (IpsecGlobalConfig
or None
) – IPsec Global configuration details.
enabled (bool
or None
) – Value is true if feature is enabled. Default value is true.
-Optional.
sites (IpsecSites
or None
) – IPsec Site configuration details.
disable_event (bool
or None
) – Enable/disable event generation on NSX Edge appliance for IPsec.
version (long
or None
) – Version number tracking each configuration change. To avoid
+
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Dashboard 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.
ipsec_bytes_out (list
of DashboardStat
or None
) – Tx transmitted bytes.
ipsec_bytes_in (list
of DashboardStat
or None
) – Rx received bytes.
ipsec_tunnels (list
of DashboardStat
or None
) – Number of Ipsec tunnels.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
IPsec 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.
psk (str
or None
) – IPsec Global Pre Shared Key. Maximum characters is 128. Required
+
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
NSX 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.
psk (str
or None
) – Pre Shared Key for the IPsec Site. Required if Site peerIp is not
+
Parameters: |
|
+
---|
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)¶
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.
channel_status (str
or None
) –
channel_state (str
or None
) –
peer_ip_address (str
or None
) –
local_ip_address (str
or None
) –
peer_subnets (list
of str
or None
) –
peer_id (str
or None
) –
last_informational_message (str
or None
) –
local_subnets (list
of str
or None
) –
Parameters: |
|
+
---|
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)¶
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.
rx_bytes_on_site (long
or None
) –
tunnel_stats (list
of IpsecTunnelStats
or None
) –
ike_status (IpsecSiteIKEStatus
or None
) –
site_status (str
or None
) –
tx_bytes_from_site (long
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
List 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.
sites (list
of IpsecSite
or None
) –
Parameters: | sites (list of IpsecSite or None ) – |
+
---|
com.vmware.vmc.model_client.
IpsecStatusAndStats
(time_stamp=None, server_status=None, site_statistics=None)¶
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.
time_stamp (long
or None
) –
server_status (str
or None
) –
site_statistics (list
of IpsecSiteStats
or None
) –
Parameters: |
|
+
---|
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)¶
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.
tunnel_status (str
or None
) –
peer_spi (str
or None
) –
rx_bytes_on_local_subnet (long
or None
) –
established_date (str
or None
) –
peer_subnet (str
or None
) –
authentication_algorithm (str
or None
) –
tunnel_state (str
or None
) –
tx_bytes_from_local_subnet (long
or None
) –
last_informational_message (str
or None
) –
local_spi (str
or None
) –
encryption_algorithm (str
or None
) –
local_subnet (str
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Key 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.
value (str
or None
) – Value corresponding to the key of the configuration limit
-parameter.
key (str
or None
) – Key name of the configuration limit parameter.
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
KmsVpcEndpoint
(vpc_endpoint_id=None, network_interface_ids=None)¶
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.
vpc_endpoint_id (str
or None
) – The identifier of the VPC endpoint created to AWS Key Management
-Service
network_interface_ids (list
of str
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Layer 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.
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.
L2Vpn
(enabled=None, sites=None, listener_ip=None)¶
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.
enabled (bool
or None
) – Enable (true) or disable (false) L2 VPN.
sites (list
of Site
) – Array of L2 vpn site config.
listener_ip (str
or None
) – Public uplink ip address. IP of external interface on which L2VPN
-service listens to.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
L2 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.
tunnel_status (str
or None
) – Status of the tunnel (UP/DOWN).
established_date (long
or None
) – Tunnel established date. format: int64
name (str
or None
) – User defined name of the site.
dropped_rx_packets (long
or None
) – Number of received packets dropped.
encryption_algorithm (str
or None
) – Cipher used in encryption.
failure_message (str
or None
) – Reason for the tunnel down.
tx_bytes_from_local_subnet (long
or None
) – Number of bytes transferred from local subnet.
rx_bytes_on_local_subnet (long
or None
) – Number of bytes received on the local subnet.
dropped_tx_packets (long
or None
) – Number of transferred packets dropped.
last_updated_time (long
or None
) – Time stamp of the statistics collection. format: int64
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
L2 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.
time_stamp (long
or None
) – Time stamp of statistics collection. format: int64
server_status (str
or None
) –
site_stats (list
of L2vpnStats
or None
) – List of statistics for each Site.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Licence 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.
data_permission (DataPermissions
or None
) – Data access control information for the feature.
is_licensed (bool
or None
) – Value is true if feature is licenced.
access_permission (InteractionPermissions
or None
) – Access control information for the feature.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Dashboard 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.
lb_bps_in (list
of DashboardStat
or None
) – Number of bytes in.
lb_http_reqs (list
of DashboardStat
or None
) – Number of HTTP requests received by Load Balancer.
lb_bps_out (list
of DashboardStat
or None
) – Number of bytes out.
lb_sessions (list
of DashboardStat
or None
) – Number of Load Balancer sessions.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
logging.
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.
log_level (str
or None
) – Log level. Valid values: emergency, alert, critical, error,
-warning, notice, info, debug.
enable (bool
or None
) – Logging enabled.
Parameters: |
|
+
---|
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)¶
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.
subnet_cidr (str
or None
) – the subnet cidr
name (str
or None
) – name of the network
gateway_ip (str
or None
) – gateway ip of the logical network
dhcp_enabled (str
or None
) – if ‘true’ - enabled; if ‘false’ - disabled
dhcp_ip_range (str
or None
) – ip range within the subnet mask, range delimiter is ‘-‘ (example
-10.118.10.130-10.118.10.140)
tunnel_id (long
or None
) – tunnel id of extended network format: int32
id (str
or None
) –
network_type (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
NETWORK_TYPE_EXTENDED
= 'EXTENDED'¶com.vmware.vmc.model_client.
LogicalRouterScope
(type=None, id=None)¶
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.
type (str
or None
) –
id (str
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
LogicalRouterScopes
(logical_router_scope=None)¶
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.
logical_router_scope (list
of LogicalRouterScope
or None
) –
Parameters: | logical_router_scope (list of LogicalRouterScope or None ) – |
+
---|
com.vmware.vmc.model_client.
MacAddress
(edge_vm_ha_index=None, value=None)¶
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.
edge_vm_ha_index (long
or None
) –
value (str
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
MaintenanceWindow
(day_of_week=None, hour_of_day=None)¶
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.
day_of_week (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
DAY_OF_WEEK_FRIDAY
= 'FRIDAY'¶com.vmware.vmc.model_client.
MaintenanceWindowEntry
(in_maintenance_window=None, reservation_schedule=None, reservation_id=None, in_maintenance_mode=None, sddc_id=None)¶
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.
in_maintenance_window (bool
or None
) – true if the SDDC is in the defined Mainentance Window
reservation_schedule (ReservationSchedule
or None
) –
reservation_id (str
or None
) – ID for reservation format: uuid
in_maintenance_mode (bool
or None
) – true if the SDDC is currently undergoing maintenance
sddc_id (str
or None
) – SDDC ID for this reservation format: uuid
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
MaintenanceWindowGet
(day_of_week=None, hour_of_day=None, duration_min=None, version=None)¶
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.
day_of_week (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
DAY_OF_WEEK_FRIDAY
= 'FRIDAY'¶com.vmware.vmc.model_client.
ManagementGatewayTemplate
(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, subnet_cidr=None)¶
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.
public_ip (SddcPublicIp
or None
) –
primary_dns (str
or None
) –
secondary_dns (str
or None
) –
firewall_rules (list
of FirewallRule
or None
) –
vpns (list
of Vpn
or None
) –
subnet_cidr (str
or None
) – mgw network subnet cidr
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
MapZonesRequest
(connected_account_id=None, org_id=None, petronas_regions_to_map=None)¶
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.
connected_account_id (str
or None
) – The connected account ID to remap. This is a standard UUID.
org_id (str
or None
) – The org ID to remap in. This is a standard UUID.
petronas_regions_to_map (list
of str
or None
) – A list of Petronas regions to map.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Start 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.
vnics (list
of Vnic
or None
) – Statistics data is collected for these vNICs.
end_time (long
or None
) – End time in seconds. format: int64
start_time (long
or None
) – Start time in seconds. format: int64
interval (long
or None
) – Time interval in seconds. format: int32
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
metadata 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.
timestamp (str
or None
) – the timestamp for the bundle
cycle_id (str
or None
) – the cycle id
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
NAT 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.
rules (NatRules
or None
) – Ordered list of NAT rules.
feature_type (str
or None
) –
version (long
or None
) – Version number tracking each configuration change. To avoid
+
Parameters: |
|
+
---|
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)¶
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.
rule_type (str
or None
) –
protocol (str
or None
) –
name (str
or None
) –
internal_ports (str
or None
) –
public_ports (str
or None
) –
public_ip (str
or None
) –
internal_ip (str
or None
) –
action (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
ACTION_DNAT
= 'dnat'¶Bases: vmware.vapi.bindings.struct.VapiStruct
Ordered 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.
nat_rules_dtos (list
of Nsxnatrule
or None
) – Ordered list of NAT rules.
Parameters: | nat_rules_dtos (list of Nsxnatrule or None ) – Ordered list of NAT rules. |
+
---|
com.vmware.vmc.model_client.
NetworkTemplate
(management_gateway_templates=None, compute_gateway_templates=None)¶
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.
management_gateway_templates (list
of ManagementGatewayTemplate
or None
) –
compute_gateway_templates (list
of ComputeGatewayTemplate
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
NewCredentials
(username=None, password=None, name=None)¶
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.
username (str
) – Username of the credentials
password (str
) – Password associated with the credentials
name (str
) – Name of the credentials
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
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.
rule_type (str
or None
) – Identifies the type of the rule. internal_high or user.
description (str
or None
) – Description for the rule
rule_id (long
or None
) – Identifier for the rule. format: int64
match_translated (bool
or None
) – Defines the order of NAT and Firewall pipeline. When false,
-firewall happens before NAT. Default : false
invalid_application (bool
or None
) –
direction (str
or None
) – Direction. Possible values in or out. Default is ‘any’.
statistics (FirewallRuleStats
or None
) – Statistics for the rule
name (str
or None
) – Name for the rule.
invalid_source (bool
or None
) –
logging_enabled (bool
or None
) – Enable logging for the rule.
destination (AddressFWSourceDestination
or None
) – List of destinations. Default is any.
enabled (bool
or None
) – Enable rule.
application (Application
or None
) – List of applications. Default is any.
source (AddressFWSourceDestination
or None
) – List of sources. Default is any.
action (str
or None
) – Action. Values : accept, deny
invalid_destination (bool
or None
) –
rule_tag (long
or None
) – Rule tag. Used to specify user-defined ruleId. If not specified NSX
-Manager will generate ruleId. format: int64
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Application (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.
source_port (list
of str
or None
) – List of source ports.
protocol (str
or None
) – Protocol.
port (list
of str
or None
) – List of destination ports.
icmp_type (str
or None
) – IcmpType. Only supported when protocol is icmp. Default is ‘any’.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
L2 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.
listener_ips (list
of str
) – Listener IP addresses.
enabled (bool
or None
) – Enabled state of L2 VPN service.
sites (Sites
) – List of L2 VPN sites.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
NAT 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.
vnic (str
or None
) – Interface on which the NAT rule is applied.
rule_type (str
or None
) – Identifies the type of the rule. internal_high or user.
protocol (str
or None
) – Protocol. Default is ‘any’
description (str
or None
) – Description for the rule.
rule_id (long
or None
) – Identifier for the rule. format: int64
snat_match_destination_port (str
or None
) – Apply SNAT rule only if traffic has this destination port. Default
-is ‘any’.
original_address (str
or None
) – Original address or address range. This is the original source
+
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
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.
secure_traffic (bool
or None
) – Secure L2VPN traffic.
site_id (str
or None
) – Identifier for L2 VPN site.
name (str
or None
) – Name of L2 VPN site. Length: 1-255 characters.
password (str
or None
) – Password for L2 VPN user. Passwords must contain the following:
+
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Details 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.
enable_nsx_advanced_addon (bool
or None
) – Indicates whether NSX Advanced addon is enabled or disabled.
Parameters: | enable_nsx_advanced_addon (bool or None ) – Indicates whether NSX Advanced addon is enabled or disabled. |
+
---|
com.vmware.vmc.model_client.
ObjectType
(name=None)¶
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.
name (str
or None
) –
Parameters: | name (str or None ) – |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Holder 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.
on_demand (OnDemandOfferInstance
) –
offers (list
of TermOfferInstance
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
OfferType
(string)¶
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 @@ -3881,19 +4340,22 @@ enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.
string (str
) – String value for the OfferType
instance.
Parameters: | string (str ) – String value for the OfferType instance. |
+
---|
ON_DEMAND
= OfferType(string='ON_DEMAND')¶ON_DEMAND
= OfferType(string=u'ON_DEMAND')¶
TERM
= OfferType(string='TERM')¶TERM
= OfferType(string=u'TERM')¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Holder 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.
product_type (str
) –
name (str
) –
currency (str
) –
region (str
) –
unit_price (str
) –
monthly_cost (str
) –
version (str
) –
description (str
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
OrgProperties
(values=None)¶
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.
values ((dict
of str
and str
) or None
) – A map of string properties to values.
Parameters: | values ((dict of str and str ) or None ) – A map of string properties to values. |
+
---|
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)¶
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.
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 (str
or None
) – 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 (str
or None
) – ORG_TYPE to be associated with the org
display_name (str
or None
) –
name (str
or None
) –
project_state (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
PROJECT_STATE_CREATED
= 'CREATED'¶Bases: vmware.vapi.bindings.struct.VapiStruct
NSX 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.
edge_page (DataPageEdgeSummary
or None
) – Page details with matched records.
Parameters: | edge_page (DataPageEdgeSummary or None ) – Page details with matched records. |
+
---|
com.vmware.vmc.model_client.
PagingInfo
(sort_order_ascending=None, total_count=None, start_index=None, sort_by=None, page_size=None)¶
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.
sort_order_ascending (bool
or None
) –
total_count (long
or None
) –
start_index (long
or None
) –
sort_by (str
or None
) –
page_size (long
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
PopAgentXeniConnection
(default_subnet_route=None, eni_info=None)¶
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.
default_subnet_route (str
or None
) – The gateway route ip fo the subnet.
eni_info ((dict
of str
and EniInfo
) or None
) – Information of the x-eni created.
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
PopAmiInfo
(region=None, id=None, name=None, type=None)¶
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.
region (str
or None
) – the region of the esx ami
id (str
or None
) – the ami id for the esx
name (str
or None
) – the name of the esx ami
type (str
or None
) –
Possible values are:
+Parameters: |
PoP AMI type. CENTOS: a Centos AMI; POP: a PoP AMI.
+
|
+
---|
TYPE_CENTOS
= 'CENTOS'¶Bases: vmware.vapi.bindings.struct.VapiStruct
Present 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.
ami_infos (dict
of str
and PopAmiInfo
) – A map of [region name of PoP / PoP-AMI]:[PopAmiInfo].
created_at (datetime.datetime
or None
) – The PopInfo (or PoP AMI) created time. Using ISO 8601 date-time
-pattern. format: date-time
id (str
or None
) – UUID of the PopInfo format: UUID
service_infos ((dict
of str
and PopServiceInfo
) or None
) – A map of [service type]:[PopServiceInfo]
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
PopServiceInfo
(cln=None, version=None, build=None, service=None)¶
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.
cln (str
or None
) – The service change set number.
version (str
or None
) – The service API version.
build (str
or None
) – The service build number.
service (str
or None
) –
Possible values are:
+Parameters: |
An enum of PoP related services (including os platform and JRE).
+
|
+
---|
SERVICE_AGENT
= 'AGENT'¶Bases: vmware.vapi.bindings.struct.VapiStruct
DNS 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.
total (long
or None
) –
queries (long
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
Reservation
(duration=None, rid=None, create_time=None, start_time=None, metadata=None)¶
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.
duration (long
or None
) – Duration - required for reservation in maintenance window format:
-int64
rid (str
or None
) – Reservation ID format: uuid
create_time (str
or None
) – Optional
start_time (datetime.datetime
or None
) – Start time of a reservation format: date-time
metadata ((dict
of str
and str
) or None
) – Optional
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
ReservationInMw
(rid=None, week_of=None, create_time=None, metadata=None)¶
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.
rid (str
or None
) – Reservation ID format: uuid
week_of (str
or None
) – SUNDAY of the week that maintenance is scheduled, ISO format date
create_time (datetime.datetime
or None
) – Optional format: date-time
metadata ((dict
of str
and str
) or None
) – Optional
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
ReservationSchedule
(day_of_week=None, hour_of_day=None, duration_min=None, version=None, reservations=None, reservations_mw=None)¶
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.
day_of_week (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
DAY_OF_WEEK_FRIDAY
= 'FRIDAY'¶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)¶
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.
reservation_state (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
RESERVATION_STATE_CANCELED
= 'CANCELED'¶com.vmware.vmc.model_client.
ReservationWindowMaintenanceProperties
(status=None)¶
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.
status (str
or None
) – Status of upgrade, if any
Parameters: | status (str or None ) – Status of upgrade, if any |
+
---|
Job 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.
value (str
or None
) – Job Result value associated with key ID.
key (str
or None
) – Job Result key ID.
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
ScopeInfo
(object_type_name=None, id=None, name=None)¶
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.
object_type_name (str
or None
) –
id (str
or None
) –
name (str
or None
) –
Parameters: |
|
+
---|
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)¶
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.
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 (str
or None
) – 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 (str
or None
) – name for SDDC
sddc_state (str
or None
) –
Possible values are:
+Parameters: |
Account linking state of the sddc
+
+ |
+
---|
ACCOUNT_LINK_STATE_DELAYED
= 'DELAYED'¶com.vmware.vmc.model_client.
SddcAllocatePublicIpSpec
(count=None, private_ips=None, names=None)¶
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.
count (long
) –
private_ips (list
of str
or None
) – List of workload VM private IPs to be assigned the public IP just
-allocated.
names (list
of str
or None
) – List of names for the workload VM public IP assignment.
Parameters: |
|
+
---|
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)¶
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.
storage_capacity (long
or None
) – The storage capacity value to be requested for the sddc primary
+
Parameters: |
|
+
---|
DEPLOYMENT_TYPE_MULTIAZ
= 'MultiAZ'¶com.vmware.vmc.model_client.
SddcId
(sddc_id=None)¶
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.
sddc_id (str
or None
) – Sddc ID
Parameters: | sddc_id (str or None ) – Sddc ID |
+
---|
com.vmware.vmc.model_client.
SddcLinkConfig
(customer_subnet_ids=None, connected_account_id=None)¶
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.
customer_subnet_ids (list
of str
or None
) –
connected_account_id (str
or None
) – Determines which connected customer account to link to
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Describes 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.
vmc_version (str
or None
) – the vmcVersion of the sddc for display
glcm_bundle (GlcmBundle
or None
) –
pop_info (PopInfo
or None
) –
vmc_internal_version (str
or None
) – the vmcInternalVersion of the sddc for internal use
esx_ami (AmiInfo
or None
) –
esx_nsxt_ami (AmiInfo
or None
) –
metadata (Metadata
or None
) –
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
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.
subnets (SddcNetworkAddressGroups
or None
) – Network address groups for routed logical networks.
cgw_name (str
or None
) – 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 (L2Extension
or None
) – 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 (SddcNetworkDhcpConfig
or None
) – DHCP configuration for routed logical networks.
id (str
or None
) – ID of logical network.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Logical 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.
prefix_length (str
or None
) – Prefix length of logical network.
primary_address (str
or None
) – Primary address for logical network.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Logical 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.
address_groups (list
of SddcNetworkAddressGroup
or None
) – List of logical network address groups.
Parameters: | address_groups (list of SddcNetworkAddressGroup or None ) – List of logical network address groups. |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DHCP 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.
ip_pools (list
of SddcNetworkDhcpIpPool
or None
) – List of IP pools in DHCP configuration.
Parameters: | ip_pools (list of SddcNetworkDhcpIpPool or None ) – List of IP pools in DHCP configuration. |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
DHCP 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.
ip_range (str
or None
) – IP range for DHCP IP pool.
domain_name (str
or None
) – DNS domain name.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Patch 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.
name (str
or None
) – The new name of the SDDC to be changed to.
Parameters: | name (str or None ) – The new name of the SDDC to be changed to. |
+
---|
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)¶
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.
public_ip (str
) –
name (str
or None
) –
allocation_id (str
or None
) –
dnat_rule_id (str
or None
) –
associated_private_ip (str
or None
) –
snat_rule_id (str
or None
) –
Parameters: |
|
+
---|
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)¶
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.
mgmt_appliance_network_name (str
or None
) – Name for management appliance network.
nsxt (bool
or None
) – if true, NSX-T UI is enabled.
mgw_id (str
or None
) – Management Gateway Id
nsx_mgr_url (str
or None
) – URL of the NSX Manager
psc_management_ip (str
or None
) – PSC internal management IP
psc_url (str
or None
) – URL of the PSC server
cgws (list
of str
or None
) –
availability_zones (list
of str
or None
) – Availability zones over which esx hosts are provisioned. MultiAZ
+
Parameters: |
Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC.
+
+ |
+
---|
DEPLOYMENT_TYPE_MULTI_AZ
= 'MULTI_AZ'¶com.vmware.vmc.model_client.
SddcStateRequest
(sddcs=None, states=None)¶
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.
sddcs (list
of str
or None
) –
states (list
of str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
STATES_CANCELED
= 'CANCELED'¶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)¶
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.
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 (str
or None
) – 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 (list
of AccountLinkSddcConfig
or None
) – A list of the SDDC linking configurations to use.
state (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
STATE_APPLIED
= 'APPLIED'¶Secondary 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.
type (str
or None
) –
ip_address (list
of str
or None
) – List of IP addresses.
Parameters: |
|
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Detailed 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.
default_message (str
or None
) – Error message in English.
original_service (str
) – The original service name of the error.
localized_message (str
or None
) – The localized message.
original_service_error_code (str
) – The original error code of the service.
Parameters: |
|
+
---|
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)¶
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.
password (str
or None
) – Site password.
user_id (str
or None
) – Site user id.
name (str
or None
) – Unique name for the site getting configured.
rx_bytes_on_local_subnet (long
or None
) – Bytes received on local network. format: int64
+
Parameters: |
|
+
---|
TUNNEL_STATUS_CONNECTED
= 'CONNECTED'¶Bases: vmware.vapi.bindings.struct.VapiStruct
L2 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.
sites (list
of Nsxsite
or None
) –
Parameters: | sites (list of Nsxsite or None ) – |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Dashboard 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.
active_clients (list
of DashboardStat
or None
) – Number of active clients.
sslvpn_bytes_in (list
of DashboardStat
or None
) – Rx bytes received for SSL VPN.
auth_failures (list
of DashboardStat
or None
) – Number of authentication failures.
sessions_created (list
of DashboardStat
or None
) – Number of SSL VPN sessions created.
sslvpn_bytes_out (list
of DashboardStat
or None
) – Tx bytes transmitted for SSL VPN.
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-stub_config (vmware.vapi.bindings.stub.StubConfiguration
) – Stub config instance
Parameters: | stub_config (vmware.vapi.bindings.stub.StubConfiguration ) – Stub config instance |
+
---|
NSX 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.
index (long
or None
) – 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 (str
or None
) – Name of the sub interface. Required.
address_groups (EdgeVnicAddressGroups
or None
) – Address group configuration of the sub interface.
vlan_id (long
or None
) – VLAN ID of the virtual LAN used by this sub interface. VLAN IDs can
-range from 0 to 4094. format: int32
label (str
or None
) – Sub interface label of format vNic_{index} provided by NSX Manager.
-Read only.
logical_switch_name (str
or None
) – Name of the logical switch connected to this sub interface.
is_connected (bool
or None
) – Value is true if the sub interface is connected to a logical
-switch, standard portgroup or distributed portgroup.
mtu (long
or None
) – MTU value of the sub interface. This value would be the least mtu
+
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
SubInterfaces
(sub_interfaces=None)¶
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.
sub_interfaces (list
of SubInterface
or None
) – List of sub interfaces.
Parameters: | sub_interfaces (list of SubInterface or None ) – List of sub interfaces. |
+
---|
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)¶
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.
compatible (bool
or None
) – Is this customer subnet compatible with the SDDC?
connected_account_id (str
or None
) – The ID of the connected account this subnet is from.
region_name (str
or None
) – The region this subnet is from.
availability_zone (str
or None
) – The availability zone (customer-centric) this subnet is in.
subnet_id (str
or None
) – The ID of the subnet.
subnet_cidr_block (str
or None
) – The CIDR block of the subnet.
note (str
or None
) – Why a subnet is marked as not compatible. May be blank if
-compatible.
vpc_id (str
or None
) – The ID of the VPC this subnet resides in.
vpc_cidr_block (str
or None
) – The CIDR block of the VPC containing this subnet.
name (str
or None
) – The name of the subnet. This is either the tagged name or the
-default AWS id it was given.
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
Subnets
(subnets=None)¶
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.
subnets (list
of str
or None
) – List of subnets for which IPsec VPN is configured. Subnets should
+
Parameters: | subnets (list of str or None ) – 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)
-
-
+‘0.0.0.0/0’ (any) |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
details 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.
status (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
STATUS_ACTIVATED
= 'ACTIVATED'¶Bases: vmware.vapi.bindings.struct.VapiStruct
Details 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.
product (str
or None
) – The name of the product
types (list
of str
or None
) – A list of different types/version for the product.
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
SubscriptionRequest
(product=None, product_type=None, region=None, commitment_term=None, offer_name=None, type=None, offer_version=None, quantity=None)¶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)¶
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.
product (str
or None
) – 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
region (str
) –
commitment_term (str
) –
offer_name (str
) –
type (str
or None
) – The type of the product for which the subscription needs to be
-created.
offer_version (str
) –
quantity (long
) –
Parameters: |
|
+
---|
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)¶
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.
start_day (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
START_DAY_FRIDAY
= 'FRIDAY'¶com.vmware.vmc.model_client.
SupportWindowId
(window_id=None)¶
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.
window_id (str
or None
) – Support Window ID
Parameters: | window_id (str or None ) – Support Window ID |
+
---|
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)¶
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.
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 (str
or None
) – 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 (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
STATUS_CANCELED
= 'CANCELED'¶A 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.
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: |
|
+
---|
com.vmware.vmc.model_client.
TermOfferInstance
(product_type=None, name=None, region=None, commitment_term=None, unit_price=None, currency=None, version=None, description=None)¶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)¶
Bases: vmware.vapi.bindings.struct.VapiStruct
Holder 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.
product_type (str
) –
name (str
) –
region (str
) –
commitment_term (long
) –
unit_price (str
) –
currency (str
) –
version (str
) –
description (str
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
TrafficShapingPolicy
(burst_size=None, average_bandwidth=None, peak_bandwidth=None, enabled=None, inherited=None)¶
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.
burst_size (long
or None
) –
average_bandwidth (long
or None
) –
peak_bandwidth (long
or None
) –
enabled (bool
or None
) –
inherited (bool
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
UpdateCredentials
(username=None, password=None)¶
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.
username (str
) – Username of the credentials
password (str
) – Password associated with the credentials
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
VmcLocale
(locale=None)¶
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.
locale (str
or None
) – The locale to be used for translating responses for the session
Parameters: | locale (str or None ) – The locale to be used for translating responses for the session |
+
---|
Bases: vmware.vapi.bindings.struct.VapiStruct
NSX 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.
sub_interfaces (SubInterfaces
or None
) – List of sub interfaces. Sub interfaces can be created only on a
-trunk interface.
address_groups (EdgeVnicAddressGroups
or None
) – Address group configuration of the interface.
is_connected (bool
or None
) – Value is true if the vnic is connected to a logical switch,
-standard portgroup or distributed portgroup.
enable_send_redirects (bool
or None
) – Value is true if send redirects is enabled. Enable ICMP redirect to
-convey routing information to hosts.
in_shaping_policy (TrafficShapingPolicy
or None
) –
label (str
or None
) – Interface label of format vNic_{vnicIndex} provided by NSX Manager.
-Read only.
enable_proxy_arp (bool
or None
) – Value is true if proxy arp is enabled. Enable proxy ARP if you want
+
Parameters: |
|
+
---|
Ordered 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.
vnics (list
of Vnic
or None
) – Ordered list of NSX Edge vnics.
Parameters: | vnics (list of Vnic or None ) – Ordered list of NSX Edge vnics. |
+
---|
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)¶
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.
vpc_cidr (str
or None
) –
vm_security_group_id (str
or None
) –
route_table_id (str
or None
) –
edge_subnet_id (str
or None
) – Id of the NSX edge associated with this VPC
id (str
or None
) –
api_association_id (str
or None
) – Id of the association between subnet and route-table
private_subnet_id (str
or None
) –
api_subnet_id (str
or None
) – Id associated with this VPC
esx_security_group_id (str
or None
) –
subnet_id (str
or None
) –
internet_gateway_id (str
or None
) –
security_group_id (str
or None
) –
association_id (str
or None
) –
vgw_route_table_id (str
or None
) – Route table which contains the route to VGW
edge_association_id (str
or None
) – Id of the association between edge subnet and route-table
vif_ids (list
of str
or None
) –
peering_connection_id (str
or None
) –
Parameters: |
|
+
---|
com.vmware.vmc.model_client.
VpcInfoSubnets
(vpc_id=None, cidr_block=None, description=None, subnets=None)¶
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.
vpc_id (str
or None
) – The ID of the VPC these subnets belong to.
cidr_block (str
or None
) – The overall CIDR block of the VPC. This is the AWS primary CIDR
-block.
description (str
or None
) – The description of the VPC; usually it’s name or id.
subnets (list
of SubnetInfo
or None
) –
Parameters: |
|
+
---|
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)¶
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.
version (str
or None
) –
on_prem_gateway_ip (str
or None
) –
on_prem_network_cidr (str
or None
) –
pfs_enabled (bool
or None
) –
id (str
or None
) –
channel_status (VpnChannelStatus
or None
) –
on_prem_nat_ip (str
or None
) –
name (str
or None
) –
internal_network_ids (list
of str
or None
) –
tunnel_statuses (list
of VpnTunnelStatus
or None
) –
encryption (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
AUTHENTICATION_PSK
= 'PSK'¶com.vmware.vmc.model_client.
VpnChannelStatus
(channel_status=None, channel_state=None, last_info_message=None, failure_message=None)¶
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.
channel_status (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
CHANNEL_STATUS_CONNECTED
= 'CONNECTED'¶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)¶
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.
on_prem_subnet (str
or None
) –
traffic_stats (VpnTunnelTrafficStats
or None
) –
last_info_message (str
or None
) –
local_subnet (str
or None
) –
tunnel_state (str
or None
) –
failure_message (str
or None
) –
tunnel_status (str
or None
) –
Possible values are:
+Parameters: |
|
+
---|
TUNNEL_STATUS_CONNECTED
= 'CONNECTED'¶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)¶
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.
packets_out (str
or None
) –
packet_received_errors (str
or None
) –
rx_bytes_on_local_subnet (str
or None
) –
replay_errors (str
or None
) –
sequence_number_over_flow_errors (str
or None
) –
encryption_failures (str
or None
) –
integrity_errors (str
or None
) –
packet_sent_errors (str
or None
) –
decryption_failures (str
or None
) –
packets_in (str
or None
) –
tx_bytes_from_local_subnet (str
or None
) –
Parameters: |
|
+
---|
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.
max_capacity (long
) – Maximum capacity supported for cluster (GiB). format: int64
recommended_capacities (list
of long
) – List of supported capacities which may offer preferable performance
-(GiB). format: int64
supported_capacity_increment (long
or None
) – 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: |
|
+
---|
com.vmware.vmc.model_client.
VsanEncryptionConfig
(port=None, certificate=None)¶
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.
port (long
or None
) – Port to connect to AWS Key Management Service
certificate (str
or None
) – Public certificate used to connect to AWS Key Management Service
Parameters: |
|
+
---|
com.vmware.vmc.orgs_client.
AccountLink
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
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 |
+
com.vmware.vmc.orgs_client.
Providers
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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)¶org (str
) – Organization identifier. (required)
com.vmware.vapi.std.errors_client.Unauthenticated
-Unauthorized
com.vmware.vapi.std.errors_client.Unauthorized
-Forbidden
com.vmware.vapi.std.errors_client.NotFound
-Organization doesn’t exist
Parameters: | org (str ) – Organization identifier. (required) |
+
---|---|
Return type: | list of com.vmware.vmc.model_client.AwsCloudProvider |
+
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.
Reservations
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
com.vmware.vapi.std.errors_client.Unauthenticated
-Unauthorized
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: | list of com.vmware.vmc.model_client.MaintenanceWindowEntry |
+
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 |
+
com.vmware.vmc.orgs_client.
SddcTemplates
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
template_id (str
) – SDDC Template identifier (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
get
(org, template_id)¶Get configuration template by given template id.
-org (str
) – Organization identifier. (required)
template_id (str
) – SDDC Template identifier (required)
Parameters: |
com.vmware.vmc.model.SddcTemplate -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.SddcTemplate + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
list
(org)¶List all available SDDC configuration templates in an organization
-org (str
) – Organization identifier. (required)
com.vmware.vapi.std.errors_client.Unauthenticated
-Unauthorized
com.vmware.vapi.std.errors_client.Unauthorized
-Forbidden
Parameters: | org (str ) – Organization identifier. (required) |
+
---|---|
Return type: | list of com.vmware.vmc.model_client.SddcTemplate |
+
Returns: | + |
Raise: | com.vmware.vapi.std.errors_client.Unauthenticated
+Unauthorized |
+
Raise: | com.vmware.vapi.std.errors_client.Unauthorized
+Forbidden |
+
com.vmware.vmc.orgs_client.
Sddcs
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
sddc_config (com.vmware.vmc.model_client.AwsSddcConfig
) – sddcConfig (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
delete
(org, sddc, retain_configuration=None, template_name=None, force=None)¶Delete SDDC
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
retain_configuration (bool
or None
) – If = ‘true’, the SDDC’s configuration is retained as a template for
+
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, sddc)¶Get SDDC
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
Parameters: |
com.vmware.vmc.model.Sddc -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Sddc + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
list
(org)¶List all the SDDCs of an organization
-org (str
) – Organization identifier. (required)
com.vmware.vapi.std.errors_client.Unauthenticated
-Unauthorized
com.vmware.vapi.std.errors_client.Unauthorized
-Forbidden
Parameters: | org (str ) – Organization identifier. (required) |
+
---|---|
Return type: | list of com.vmware.vmc.model_client.Sddc |
+
Returns: | + |
Raise: | com.vmware.vapi.std.errors_client.Unauthenticated
+Unauthorized |
+
Raise: | com.vmware.vapi.std.errors_client.Unauthorized
+Forbidden |
+
patch
(org, sddc, sddc_patch_request)¶Patch SDDC
-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: |
com.vmware.vmc.model.Sddc -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Sddc + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Subscriptions
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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'¶create
(org, subscription_request)¶Initiates the creation of a subscription
-org (str
) – Organization identifier. (required)
subscription_request (com.vmware.vmc.model_client.SubscriptionRequest
) – subscriptionRequest (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, subscription)¶Get subscription details for a given subscription id
-org (str
) – Organization identifier. (required)
subscription (str
) – SubscriptionId for an sddc. (required)
Parameters: |
com.vmware.vmc.model.SubscriptionDetails -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.SubscriptionDetails + |
+
Raise: |
|
+
Raise: |
|
+
get_0
(org, offer_type=None)¶Returns all subscriptions for a given org id
-org (str
) – Organization identifier. (required)
offer_type (str
or None
) – Offer Type * `ON_DEMAND` - on-demand subscription *
+
Parameters: |
|
+
---|---|
Return type: | + | +
Returns: | + | +
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs_client.
Tasks
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
task (str
) – Task identifier (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
list
(org, filter=None)¶List all tasks with optional filtering.
-org (str
) – Organization identifier. (required)
filter (str
or None
) – Filter expression Binary Operators: ‘eq’, ‘ne’, ‘lt’, ‘gt’, ‘le’,
+
Parameters: |
|
+
---|---|
Return type: | + | +
Returns: | + | +
Raise: |
|
+
Raise: |
|
+
org (str
) – Organization identifier. (required)
task (str
) – Task identifier (required)
action (str
or None
) – If = ‘cancel’, task will be canceled (optional)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.account_link_client.
CompatibleSubnets
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
linked_account_id (str
or None
) – The linked connected account identifier (optional)
region (str
or None
) – The region of the cloud resources to work in (optional)
sddc (str
or None
) – sddc (optional)
force_refresh (bool
or None
) – When true, forces the mappings for datacenters to be refreshed for
-the connected account. (optional)
instance_type (str
or None
) – The server instance type to be used. (optional)
Parameters: |
com.vmware.vmc.model.AwsCompatibleSubnets -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.AwsCompatibleSubnets + |
+
Raise: |
|
+
Raise: |
|
+
post
(org)¶
Sets which subnet to use to link accounts and finishes the linking process
-org (str
) – Organization identifier. (required)
com.vmware.vmc.model.AwsSubnet
-com.vmware.vapi.std.errors_client.Unauthenticated
-Unauthorized
com.vmware.vapi.std.errors_client.Unauthorized
-Forbidden
Parameters: | org (str ) – Organization identifier. (required) |
+
---|---|
Return type: | com.vmware.vmc.model_client.AwsSubnet |
+
Returns: | com.vmware.vmc.model.AwsSubnet | +
Raise: | com.vmware.vapi.std.errors_client.Unauthenticated
+Unauthorized |
+
Raise: | com.vmware.vapi.std.errors_client.Unauthorized
+Forbidden |
+
com.vmware.vmc.orgs.account_link_client.
CompatibleSubnetsAsync
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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)¶org (str
) – Organization identifier. (required)
linked_account_id (str
or None
) – The linked connected account identifier (optional)
region (str
or None
) – The region of the cloud resources to work in (optional)
sddc (str
or None
) – sddc (optional)
instance_type (str
or None
) – The server instance type to be used. (optional)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
post
(aws_subnet, org)¶
Sets which subnet to use to link accounts and finishes the linking process via a task
-aws_subnet (com.vmware.vmc.model_client.AwsSubnet
) – The subnet chosen by the customer (required)
org (str
) – Organization identifier. (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.account_link_client.
ConnectedAccounts
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
linked_account_path_id (str
) – The linked connected account identifier (required)
force_even_when_sddc_present (bool
or None
) – When true, forcibly removes a connected account even when SDDC’s
-are still linked to it. (optional)
Parameters: |
com.vmware.vmc.model.AwsCustomerConnectedAccount -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.AwsCustomerConnectedAccount + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, provider=None)¶Get a list of connected accounts
-org (str
) – Organization identifier. (required)
provider (str
or None
) – The cloud provider of the SDDC (AWS or ZeroCloud). Default value is
-AWS. (optional)
Parameters: |
|
+
---|---|
Return type: |
|
+
Returns: | + | +
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.account_link_client.
MapCustomerZones
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-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: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.account_link_client.
SddcConnections
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
sddc (str
or None
) – sddc (optional)
Parameters: |
|
+
---|---|
Return type: | + | +
Returns: | + | +
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.account_link_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Mw
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
reservation (str
) – Reservation Identifier (required)
Parameters: |
com.vmware.vmc.model.MaintenanceWindowGet -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.MaintenanceWindowGet + |
+
Raise: |
|
+
Raise: |
|
+
put
(org, reservation, window)¶update the maintenance window for this SDDC
-org (str
) – Organization identifier. (required)
reservation (str
) – Reservation Identifier (required)
window (com.vmware.vmc.model_client.MaintenanceWindow
) – Maintenance Window (required)
Parameters: |
com.vmware.vmc.model.MaintenanceWindow -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.MaintenanceWindow + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.reservations_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Clusters
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
cluster_config (com.vmware.vmc.model_client.ClusterConfig
) – clusterConfig (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
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.
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
cluster (str
) – cluster identifier (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs_client.
Convert
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs_client.
Esxs
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
esx_config (com.vmware.vmc.model_client.EsxConfig
) – esxConfig (required)
action (str
or None
) – If = ‘add’, will add the esx. If = ‘remove’, will delete the
+
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs_client.
Publicips
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
spec (com.vmware.vmc.model_client.SddcAllocatePublicIpSpec
) – allocation spec (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
delete
(org, sddc, id)¶Free one public IP for a SDDC
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
id (str
) – ip allocation id (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, sddc, id)¶Get one public IP for a SDDC
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
id (str
) – ip allocation id (required)
Parameters: |
com.vmware.vmc.model.SddcPublicIp -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.SddcPublicIp + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
list
(org, sddc)¶list all public IPs for a SDDC
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
Parameters: |
|
+
---|---|
Return type: | + | +
Returns: | + | +
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
update
(org, sddc, id, action, sddc_public_ip_object)¶Attach or detach a public IP to workload VM for a SDDC
-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: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs_client.
SddcTemplate
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
Parameters: |
com.vmware.vmc.model.SddcTemplate -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.SddcTemplate + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
ClusterConstraints
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
provider (str
) – Cloud storage provider ID (example AWS) (required)
num_hosts (long
) – Number of hosts in cluster (required)
Parameters: |
com.vmware.vmc.model.VsanConfigConstraints -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.VsanConfigConstraints + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.storage_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
OfferInstances
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-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 (str
or None
) – The product that you are trying to purchase, eg. host. This needs
-to be accompanied by the type parameter (optional)
type (str
or None
) – The type/flavor of the product you are trying it purchase,eg. an
+
Parameters: |
com.vmware.vmc.model.OfferInstancesHolder -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.OfferInstancesHolder + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.subscriptions_client.
Products
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
com.vmware.vapi.std.errors_client.Unauthenticated
-Unauthorized
com.vmware.vapi.std.errors_client.Unauthorized
-Forbidden
com.vmware.vapi.std.errors_client.InternalServerError
-Internal server error
Parameters: | org (str ) – Organization identifier. (required) |
+
---|---|
Return type: | list of com.vmware.vmc.model_client.SubscriptionProducts |
+
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 |
+
com.vmware.vmc.orgs.subscriptions_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Reservation
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
sddc_state (com.vmware.vmc.model_client.SddcStateRequest
or None
) – SDDCs and/or states to query (optional)
Parameters: |
|
+
---|---|
Return type: |
|
+
Returns: | + | +
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.tbrs_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
SupportWindow
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
minimum_seats_available (long
or None
) – minimum seats available (used as a filter) (optional)
created_by (str
or None
) – user name which was used to create the support window (used as a
-filter) (optional)
Parameters: |
|
+
---|---|
Return type: | + | +
Returns: | + | +
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
put
(org, id, sddc_id)¶Move Sddc to new support window
-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: |
com.vmware.vmc.model.SupportWindowId -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.SupportWindowId + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.addons_client.
Credentials
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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'¶create
(org, sddc_id, addon_type, credentials)¶Associated a new add on credentials with the SDDC such as HCX
-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: |
com.vmware.vmc.model.NewCredentials -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.NewCredentials + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, sddc_id, addon_type, name)¶Get credential details by name
-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: |
com.vmware.vmc.model.NewCredentials -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.NewCredentials + |
+
Raise: |
|
+
list
(org, sddc_id, addon_type)¶List all the credentials assoicated with an addon type with in a SDDC
-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: |
|
+
---|---|
Return type: | + | +
Returns: | + | +
Raise: |
|
+
update
(org, sddc_id, addon_type, name, credentials)¶Update credential details
-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: |
com.vmware.vmc.model.NewCredentials -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.NewCredentials + |
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.addons_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Private
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.dns_client.
Public
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
Parameters: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.dns_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Dns
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
Parameters: | config (vmware.vapi.bindings.stub.StubConfiguration ) – Configuration to be used for creating the stub. |
+
---|
UPDATE_IP_TYPE_PRIVATE
= 'private'¶Possible value for ipType
of method Dns.update()
.
UPDATE_IP_TYPE_PUBLIC
= 'public'¶Possible value for ipType
of method Dns.update()
.
update
(org, sddc, management_vm_id, ip_type)¶Update the DNS records of management VMs to use public or private IP +addresses
+Parameters: |
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.management_vms_client.
StubFactory
(stub_config)¶Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
+Parameters: | stub_config (vmware.vapi.bindings.stub.StubConfiguration ) – Stub config instance |
+
---|
com.vmware.vmc.orgs.sddcs.networking_client.
ConnectivityTests
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
Parameters: |
com.vmware.vmc.model.ConnectivityValidationGroups -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.ConnectivityValidationGroups + |
+
Raise: |
|
+
Raise: |
|
+
post
(org, sddc, request_info, action)¶
ConnectivityValidationGroupResultWrapper will be available at task.params[‘test_result’].
-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: |
com.vmware.vmc.model.Task -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Task + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networking_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Edges
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_type (str
) – Retrieve records matching NSX Edge type (‘gatewayServices’ or
+
Parameters: |
com.vmware.vmc.model.PagedEdgeList -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.PagedEdgeList + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks_client.
Logical
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
sddc_network (com.vmware.vmc.model_client.SddcNetwork
) – (required)
Parameters: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
delete
(org, sddc, network_id)¶Delete a network in an SDDC.
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
network_id (str
) – Logical Network Identifier (required)
Parameters: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, sddc, network_id)¶Retrieve information about a network in an SDDC.
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
network_id (str
) – Logical Network Identifier (required)
Parameters: |
com.vmware.vmc.model.SddcNetwork -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.SddcNetwork + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
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.
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
page_size (long
or None
) – Page size for pagination. (optional)
start_index (long
or None
) – Start index of page. (optional)
prev_sddc_network_id (str
or None
) – Previous logical network id. (optional)
sort_order_ascending (bool
or None
) – Sort order ascending. (optional)
Parameters: |
com.vmware.vmc.model.DataPageSddcNetwork -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.DataPageSddcNetwork + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
update
(org, sddc, network_id, sddc_network)¶Modify a network in an SDDC.
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Config
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Compute Gateway Edge Identifier (required)
Parameters: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, sddc, edge_id, show_sensitive_data=None)¶Retrieve SDDC L2 VPN configuration.
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Compute Gateway Edge Identifier (required)
show_sensitive_data (bool
or None
) – (optional)
Parameters: |
com.vmware.vmc.model.Nsxl2vpn -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Nsxl2vpn + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
update
(org, sddc, edge_id, nsxl2vpn)¶Modify SDDC L2 VPN configuration
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Rules
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
delete
(org, sddc, edge_id, rule_id)¶
Delete a specific firewall rule for a management or compute gateway (NSX Edge).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
rule_id (long
) – Rule Identifier. (required)
Parameters: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, sddc, edge_id, rule_id)¶
Retrieve a specific firewall rule for a management or compute gateway (NSX Edge).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
rule_id (long
) – Rule Identifier. (required)
Parameters: |
com.vmware.vmc.model.Nsxfirewallrule -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Nsxfirewallrule + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
update
(org, sddc, edge_id, rule_id, nsxfirewallrule)¶
Modify the specified firewall rule for a management or compute gateway (NSX Edge).
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Leaseinfo
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
com.vmware.vmc.model.DhcpLeases -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.DhcpLeases + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Config
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
delete
(org, sddc, edge_id)¶
Delete DNS server configuration for a management or compute gateway (NSX Edge).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, sddc, edge_id)¶
Retrieve DNS server configuration for a management or compute gateway (NSX Edge).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
com.vmware.vmc.model.DnsConfig -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.DnsConfig + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
update
(org, sddc, edge_id, dns_config)¶
Configure DNS server configuration for a management or compute gateway (NSX Edge).
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.
Statistics
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
com.vmware.vmc.model.DnsStatusAndStats -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.DnsStatusAndStats + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.dns_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Config
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, sddc, edge_id)¶
Retrieve the firewall configuration for a management or compute gateway (NSX Edge).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
com.vmware.vmc.model.FirewallConfig -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.FirewallConfig + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
update
(org, sddc, edge_id, firewall_config)¶Configure firewall for a management or compute gateway (NSX Edge).
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.
Statistics
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
rule_id (long
) – Rule Identifier. (required)
Parameters: |
com.vmware.vmc.model.FirewallRuleStats -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.FirewallRuleStats + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Config
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, sddc, edge_id, show_sensitive_data=None)¶
Retrieve IPsec VPN configuration for a management or compute gateway (NSX Edge).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
show_sensitive_data (bool
or None
) – Set to true to show sensitive data. Default value is false.
-(optional)
Parameters: |
com.vmware.vmc.model.Ipsec -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Ipsec + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
update
(org, sddc, edge_id, ipsec)¶
Modify IPsec VPN configuration for a management or compute gateway (NSX Edge).
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.
Statistics
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
com.vmware.vmc.model.IpsecStatusAndStats -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.IpsecStatusAndStats + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Config
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
get
(org, sddc, edge_id)¶
Retrieve NAT configuration for a management or compute gateway (NSX Edge).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
com.vmware.vmc.model.Nat -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Nat + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
update
(org, sddc, edge_id, nat)¶
Modify NAT configuration for a management or compute gateway (NSX Edge).
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.nat_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Interfaces
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
start_time (long
or None
) – Show statistics from this start time (in milliseconds since epoch).
-(optional)
end_time (long
or None
) – Show statistics until this end time (in milliseconds since epoch).
-(optional)
Parameters: |
com.vmware.vmc.model.CbmStatistics -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.CbmStatistics + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Statistics
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
com.vmware.vmc.model.L2vpnStatusAndStats -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.L2vpnStatusAndStats + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Rules
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
delete
(org, sddc, edge_id, rule_id)¶
Delete the specific NAT rule for a management or compute gateway (NSX Edge).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
rule_id (long
) – Rule Identifier. (required)
Parameters: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
update
(org, sddc, edge_id, rule_id, nsxnatrule)¶
Update the specific NAT rule for a management or compute gateway (NSX Edge).
-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: |
|
+
---|---|
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Firewall
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
interval (str
or None
) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
-oneMonth, oneYear. (optional)
Parameters: |
com.vmware.vmc.model.DashboardStatistics -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.DashboardStatistics + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.
Interface
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
interval (str
or None
) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
-oneMonth, oneYear. (optional)
Parameters: |
com.vmware.vmc.model.DashboardStatistics -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.DashboardStatistics + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.
Ipsec
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
interval (str
or None
) – 60 min by default, can be given as 1 - 60 min, oneDay, oneWeek,
-oneMonth, oneYear. (optional)
Parameters: |
com.vmware.vmc.model.DashboardStatistics -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.DashboardStatistics + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Internal
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
start_time (long
or None
) – Show statistics from this start time (in milliseconds since epoch).
-(optional)
end_time (long
or None
) – Show statistics until this end time (in milliseconds since epoch).
-(optional)
Parameters: |
com.vmware.vmc.model.CbmStatistics -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.CbmStatistics + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Uplink
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
start_time (long
or None
) – Show statistics from this start time (in milliseconds since epoch).
-(optional)
end_time (long
or None
) – Show statistics until this end time (in milliseconds since epoch).
-(optional)
Parameters: |
com.vmware.vmc.model.CbmStatistics -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.CbmStatistics + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges_client.
Peerconfig
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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.
-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 (str
or None
) – Specify template identifier and response format. Valid values are
-‘text’, ‘json’ and ‘xml’. Default is ‘text’. Optional. (optional)
Parameters: |
DynamicStructure -
|
+
---|---|
Return type: |
|
+
Returns: | DynamicStructure + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges_client.
Status
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
getlatest (bool
or None
) – If true, retrieve the status live from the gateway (NSX Edge). If
+
Parameters: |
com.vmware.vmc.model.EdgeStatus -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.EdgeStatus + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
com.vmware.vmc.orgs.sddcs.networks.edges_client.
StubFactory
(stub_config)¶
Bases: vmware.vapi.bindings.stub.StubFactoryBase
Initialize StubFactoryBase
-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.
Vnics
(config)¶Bases: vmware.vapi.bindings.stub.VapiInterface
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).
-org (str
) – Organization identifier. (required)
sddc (str
) – Sddc Identifier. (required)
edge_id (str
) – Edge Identifier. (required)
Parameters: |
com.vmware.vmc.model.Vnics -
|
+
---|---|
Return type: | + | +
Returns: | com.vmware.vmc.model.Vnics + |
+
Raise: |
|
+
Raise: |
|
+
Raise: |
|
+
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.
Bases: vmware.vapi.bindings.enum.Enum
+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.
If the source is backed by a file.
-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.
# SourceType is an enumerated type
from com.vmware.vapi.metadata_client import SourceType
@@ -198,7 +199,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.
# SourceType is an enumerated type
from com.vmware.vapi.metadata_client import SourceType
@@ -214,7 +215,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.
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 5f676c41..0c2c8aa7 100644 --- a/vmc/genindex.html +++ b/vmc/genindex.html @@ -9,7 +9,7 @@ -com
com
com.vmware
com.vmware.vmc
com.vmware.vmc.model_client
com.vmware.vmc.orgs
com.vmware.vmc.orgs.account_link_client
com.vmware.vmc.orgs.reservations_client
com.vmware.vmc.orgs.sddcs
com.vmware.vmc.orgs.sddcs.addons_client
com.vmware.vmc.orgs.sddcs.dns_client
com.vmware.vmc.orgs.sddcs.management_vms_client
com.vmware.vmc.orgs.sddcs.networking_client
com.vmware.vmc.orgs.sddcs.networks
com.vmware.vmc.orgs.sddcs.networks.cgws
com.vmware.vmc.orgs.sddcs.networks.cgws.l2vpn_client
com.vmware.vmc.orgs.sddcs.networks.edges
com.vmware.vmc.orgs.sddcs.networks.edges.dhcp_client
com.vmware.vmc.orgs.sddcs.networks.edges.dns_client
com.vmware.vmc.orgs.sddcs.networks.edges.firewall
com.vmware.vmc.orgs.sddcs.networks.edges.firewall.config_client
com.vmware.vmc.orgs.sddcs.networks.edges.firewall_client
com.vmware.vmc.orgs.sddcs.networks.edges.ipsec_client
com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn
com.vmware.vmc.orgs.sddcs.networks.edges.l2vpn.config_client
com.vmware.vmc.orgs.sddcs.networks.edges.nat
com.vmware.vmc.orgs.sddcs.networks.edges.nat.config_client
com.vmware.vmc.orgs.sddcs.networks.edges.nat_client
com.vmware.vmc.orgs.sddcs.networks.edges.statistics
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.dashboard_client
com.vmware.vmc.orgs.sddcs.networks.edges.statistics.interfaces_client
com.vmware.vmc.orgs.sddcs.networks.edges.statistics_client
com.vmware.vmc.orgs.sddcs.networks.edges_client
com.vmware.vmc.orgs.sddcs.networks_client
com.vmware.vmc.orgs.sddcs_client
com.vmware.vmc.orgs.storage_client
com.vmware.vmc.orgs.subscriptions_client
com.vmware.vmc.orgs.tbrs_client
com.vmware.vmc.orgs_client
com.vmware.vmc_client
vmware
vmware
vmware.vapi
vmware.vapi.vmc
vmware.vapi.vmc.client
vmware.vapi.vmc.csp_filter
Initialize VmcClient by creating a stub factory instance using a CSP Security context filter added to the filter chain of the connector
-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: |
|
+
---|
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.
-refresh_token (str
) – Refresh token obtained from CSP
session (requests.Session
or None
) – Requests HTTP session instance. If not specified, then one
-is automatically created and used
Parameters: |
VMC Client instance - |
+
---|---|
Return type: | + | +
Returns: | VMC Client instance + |
+
CSP Security Context filter in API Provider chain adds the security context based on a refresh token to the execution context passed in.
Initialize SecurityContextFilter
-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: |
|
+
---|
get_max_retries
()¶Get the max number of retries
-int
Number of retries
-Return type: | int |
+
---|---|
Returns: | Number of retries | +
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.
-on_error (bool
) – Whether this method is called after getting an error
vmware.vapi.core.SecurityContext
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.
-error_value (vmware.vapi.data.value.ErrorValue
) – Method error
bool
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 | +
\ + Sort by:\ + best rated\ + newest\ + oldest\ +
\ +\ +
Add a comment\ + (markup):
\ +``code``
, \ + code blocks:::
and an indented block after blank line