<spanid="com-vmware-vmc-package"></span><h1>com.vmware.vmc package<aclass="headerlink"href="#module-com.vmware.vmc"title="Permalink to this headline">¶</a></h1>
<divclass="section"id="subpackages">
<h2>Subpackages<aclass="headerlink"href="#subpackages"title="Permalink to this headline">¶</a></h2>
<spanid="com-vmware-vmc-model-client-module"></span><h2>com.vmware.vmc.model_client module<aclass="headerlink"href="#module-com.vmware.vmc.model_client"title="Permalink to this headline">¶</a></h2>
<li><strong>user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>updated_by_user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Version of this entity format: int32</li>
<li><strong>updated_by_user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – User name that last updated this record</li>
<li><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique ID for this entity</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">AccountLinkConfig</code><spanclass="sig-paren">(</span><em>delay_account_link=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.AccountLinkConfig"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">AccountLinkSddcConfig</code><spanclass="sig-paren">(</span><em>customer_subnet_ids=None</em>, <em>connected_account_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.AccountLinkSddcConfig"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>customer_subnet_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>connected_account_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ID of the customer connected account to work with.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">AddressFWSourceDestination</code><spanclass="sig-paren">(</span><em>exclude=None</em>, <em>ip_address=None</em>, <em>grouping_object_id=None</em>, <em>vnic_group_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.AddressFWSourceDestination"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>exclude</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Exclude the specified source or destination.</li>
<li><strong>ip_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of string. Can specify single IP address, range of IP address,
or in CIDR format. Can define multiple.</li>
<li><strong>grouping_object_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of string. Id of cluster, datacenter, distributedPortGroup,
<li><strong>vnic_group_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of string. Possible values are vnic-index-[1-9], vse, external
or internal. Can define multiple.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Agent">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Agent</code><spanclass="sig-paren">(</span><em>addresses=None</em>, <em>healthy=None</em>, <em>custom_properties=None</em>, <em>last_health_status_change=None</em>, <em>internal_ip=None</em>, <em>reserved_ip=None</em>, <em>network_netmask=None</em>, <em>network_gateway=None</em>, <em>provider='Agent'</em>, <em>agent_url=None</em>, <em>network_cidr=None</em>, <em>id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Agent"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">AmiInfo</code><spanclass="sig-paren">(</span><em>region=None</em>, <em>id=None</em>, <em>name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.AmiInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>region</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the region of the esx ami</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the ami id for the esx</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the name of the esx ami</li>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>data_store_moid_of_active_vse</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vCenter MOID of the active NSX Edge appliance’s data store.</li>
<li><strong>enable_fips</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if FIPS is enabled on NSX Edge appliance.</li>
<li><strong>host_name_of_active_vse</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Host name of the active NSX Edge appliance.</li>
<li><strong>deploy_appliances</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if NSX Edge appliances are to be deployed.</li>
<li><strong>communication_channel</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Communication channel used to communicate with NSX Edge appliance.</li>
<li><strong>vm_name_of_active_vse</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the active NSX Edge appliance.</li>
<li><strong>number_of_deployed_vms</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of deployed appliances of the NSX Edge. format: int32</li>
<li><strong>resource_pool_moid_of_active_vse</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vCenter MOID of the active NSX Edge appliance’s resource
pool/cluster. Can be resource pool ID, e.g. resgroup-15 or cluster
ID, e.g. domain-c41.</li>
<li><strong>data_store_name_of_active_vse</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datastore name of the active NSX Edge appliance.</li>
<li><strong>vm_moid_of_active_vse</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vCenter MOID of the active NSX Edge appliance.</li>
<li><strong>status_from_vse_updated_on</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Time stamp value when healthcheck status was last updated for the
NSX Edge appliance. format: int64</li>
<li><strong>fqdn</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – FQDN of the NSX Edge.</li>
<li><strong>resource_pool_name_of_active_vse</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Resource Pool/Cluster name of the active NSX Edge appliance.</li>
<li><strong>active_vse_ha_index</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – HA index of the active NSX Edge appliance. format: int32</li>
<li><strong>host_moid_of_active_vse</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vCenter MOID of the active NSX Edge appliance’s host.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Application">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Application</code><spanclass="sig-paren">(</span><em>application_id=None</em>, <em>service=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Application"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>application_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of string. Id of service or serviceGroup groupingObject. Can
define multiple.</li>
<li><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.Nsxfirewallservice"title="com.vmware.vmc.model_client.Nsxfirewallservice"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Nsxfirewallservice</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of protocol and ports. Can define multiple.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.AwsAgent">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">AwsAgent</code><spanclass="sig-paren">(</span><em>instance_id=None</em>, <em>key_pair=None</em>, <em>addresses=None</em>, <em>healthy=None</em>, <em>custom_properties=None</em>, <em>last_health_status_change=None</em>, <em>internal_ip=None</em>, <em>reserved_ip=None</em>, <em>network_netmask=None</em>, <em>network_gateway=None</em>, <em>provider='AWS'</em>, <em>agent_url=None</em>, <em>network_cidr=None</em>, <em>id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.AwsAgent"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">AwsCloudProvider</code><spanclass="sig-paren">(</span><em>regions=None</em>, <em>provider='AWS'</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.AwsCloudProvider"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>regions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the Cloud Provider</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">AwsCompatibleSubnets</code><spanclass="sig-paren">(</span><em>customer_available_zones=None</em>, <em>vpc_map=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.AwsCompatibleSubnets"title="Permalink to this definition">¶</a></dt>
<li><strong>user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>updated_by_user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Version of this entity format: int32</li>
<li><strong>updated_by_user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – User name that last updated this record</li>
<li><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique ID for this entity</li>
<li><strong>region_to_az_to_shadow_mapping</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Provides a map of regions to availability zones from the shadow
<li><strong>availability_zone</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Availability zone where the host is provisioned.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">AwsKeyPair</code><spanclass="sig-paren">(</span><em>key_name=None</em>, <em>key_fingerprint=None</em>, <em>key_material=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.AwsKeyPair"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">AwsKmsInfo</code><spanclass="sig-paren">(</span><em>amazon_resource_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.AwsKmsInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>amazon_resource_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The ARN associated with the customer master key for this cluster.</td>
<li><strong>account_link_sddc_config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.AccountLinkSddcConfig"title="com.vmware.vmc.model_client.AccountLinkSddcConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AccountLinkSddcConfig</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A list of the SDDC linking configurations to use.</li>
<li><strong>vpc_cidr</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.</li>
<li><strong>sddc_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Denotes the sddc type , if the value is null or empty, the type is
considered as default.</li>
<li><strong>vxlan_subnet</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – VXLAN IP subnet</li>
<li><strong>account_link_config</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.AccountLinkConfig"title="com.vmware.vmc.model_client.AccountLinkConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AccountLinkConfig</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The account linking configuration, we will keep this one and remove
<p>Determines what additional properties are available based on cloud
provider.</p>
</li>
<li><strong>sso_domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO domain name to use for vSphere users. If not specified,
vmc.local will be used.</li>
<li><strong>sddc_template_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If provided, configuration from the template will applied to the
<li><strong>user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>updated_by_user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Version of this entity format: int32</li>
<li><strong>updated_by_user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – User name that last updated this record</li>
<li><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique ID for this entity</li>
<li><strong>max_num_public_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – maximum number of public IP that user can allocate.</li>
<li><strong>mgmt_appliance_network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name for management appliance network.</li>
<li><strong>dns_with_management_vm_private_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – if true, use the private IP addresses to register DNS records for
<li><strong>psc_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – URL of the PSC server</li>
<li><strong>cgws</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>availability_zones</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Availability zones over which esx hosts are provisioned. MultiAZ
SDDCs will have hosts provisioned over two availability zones while
SingleAZ SDDCs will provision over one.</li>
<li><strong>management_ds</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ManagedObjectReference of the management Datastore</li>
<div>Discriminator for additional properties</div></blockquote>
</li>
<li><strong>clusters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of clusters in the SDDC.
When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<aclass="reference internal"href="#com.vmware.vmc.model_client.Cluster"title="com.vmware.vmc.model_client.Cluster"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster</span></code></a>. When methods return a value of this class as a
return value, the attribute will contain all the attributes defined
in <aclass="reference internal"href="#com.vmware.vmc.model_client.Cluster"title="com.vmware.vmc.model_client.Cluster"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster</span></code></a>.</li>
<li><strong>vc_instance_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – unique id of the vCenter server</li>
<li><strong>esx_cluster_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster Id to add ESX workflow</li>
<li><strong>vc_public_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vCenter public IP</li>
<li><strong>vc_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – URL of the vCenter server</li>
<li><strong>vxlan_subnet</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – VXLAN IP subnet</li>
<li><strong>cloud_user_group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Group name for vCenter SDDC administrator</li>
<li><strong>witness_availability_zone</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Availability zone where the witness node is provisioned for a
MultiAZ SDDC. This is null for a SingleAZ SDDC.</li>
<li><strong>sso_domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO domain name to use for vSphere users</li>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>connected_account_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The connected account ID this subnet is accessible through. This is
an internal ID formatted as a UUID specific to Skyscraper.</li>
<li><strong>region_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The region this subnet is in, usually in the form of country code,
general location, and a number (ex. us-west-2).</li>
<li><strong>availability_zone</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The availability zone this subnet is in, which should be the region
name plus one extra letter (ex. us-west-2a).</li>
<li><strong>subnet_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The subnet ID in AWS, provided in the form ‘subnet-######’.</li>
<li><strong>subnet_cidr_block</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The CIDR block of the subnet, in the form of ‘#.#.#.#/#’.</li>
<li><strong>is_compatible</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Flag indicating whether this subnet is compatible. If true, this is
a valid choice for the customer to deploy a SDDC in.</li>
<li><strong>vpc_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The VPC ID the subnet resides in within AWS. Tends to be
‘vpc-#######’.</li>
<li><strong>vpc_cidr_block</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The CIDR block of the VPC, in the form of ‘#.#.#.#/#’.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Optional field (may not be provided by AWS), indicates the found
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">CaCertificates</code><spanclass="sig-paren">(</span><em>ca_certificate=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.CaCertificates"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>ca_certificate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.CbmStatistic">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">CbmStatistic</code><spanclass="sig-paren">(</span><em>vnic=None</em>, <em>timestamp=None</em>, <em>out=None</em>, <em>in_=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.CbmStatistic"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">CbmStatistics</code><spanclass="sig-paren">(</span><em>data_dto=None</em>, <em>meta_dto=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.CbmStatistics"title="Permalink to this definition">¶</a></dt>
<li><strong>meta_dto</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.MetaDashboardStats"title="com.vmware.vmc.model_client.MetaDashboardStats"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetaDashboardStats</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Start time, end time and interval details.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.CbmStatsData">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">CbmStatsData</code><spanclass="sig-paren">(</span><em>vnic9=None</em>, <em>vnic8=None</em>, <em>vnic7=None</em>, <em>vnic6=None</em>, <em>vnic5=None</em>, <em>vnic4=None</em>, <em>vnic3=None</em>, <em>vnic2=None</em>, <em>vnic1=None</em>, <em>vnic0=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.CbmStatsData"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">CloudProvider</code><spanclass="sig-paren">(</span><em>provider='CloudProvider'</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.CloudProvider"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>provider</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the Cloud Provider</td>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Cluster</code><spanclass="sig-paren">(</span><em>esx_host_list=None</em>, <em>cluster_state=None</em>, <em>cluster_name=None</em>, <em>aws_kms_info=None</em>, <em>cluster_id='Cluster'</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Cluster"title="Permalink to this definition">¶</a></dt>
<li><strong>aws_kms_info</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.AwsKmsInfo"title="com.vmware.vmc.model_client.AwsKmsInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AwsKmsInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – AWS Key Management Service information associated with this cluster</li>
<codeclass="descname">CLUSTER_STATE_ADDING_HOSTS</code><emclass="property"> = 'ADDING_HOSTS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_ADDING_HOSTS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CLUSTER_STATE_DEPLOYING</code><emclass="property"> = 'DEPLOYING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_DEPLOYING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CLUSTER_STATE_FAILED</code><emclass="property"> = 'FAILED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CLUSTER_STATE_READY</code><emclass="property"> = 'READY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Cluster.CLUSTER_STATE_READY"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ClusterConfig</code><spanclass="sig-paren">(</span><em>num_hosts=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ClusterConfig"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ConnectivityAgentValidation</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>ports=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityAgentValidation"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TYPE_CONNECTIVITY</code><emclass="property"> = 'CONNECTIVITY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_CONNECTIVITY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TYPE_DNS</code><emclass="property"> = 'DNS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_DNS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TYPE_PING</code><emclass="property"> = 'PING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_PING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TYPE_TRACEROUTE</code><emclass="property"> = 'TRACEROUTE'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityAgentValidation.TYPE_TRACEROUTE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ConnectivityValidationGroup</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>sub_groups=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationGroup"title="Permalink to this definition">¶</a></dt>
<div>test group id, currently, only HLM.</div></blockquote>
</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the test group.</li>
<li><strong>sub_groups</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup"title="com.vmware.vmc.model_client.ConnectivityValidationSubGroup"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectivityValidationSubGroup</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of sub groups.</li>
<codeclass="descname">ID_HLM</code><emclass="property"> = 'HLM'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationGroup.ID_HLM"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ConnectivityValidationGroups</code><spanclass="sig-paren">(</span><em>groups=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationGroups"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ConnectivityValidationInput</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>value=None</em>, <em>label=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationInput"title="Permalink to this definition">¶</a></dt>
<p>input value type, i.e. HOSTNAME_OR_IP, HOST_IP, HOSTNAME. Accept
FQDN or IP address as input value when id = HOSTNAME_OR_IP, accept
FQDN ONLY when id = HOSTNAME, accept IP address ONLY when id =
HOST_IP.</p>
</li>
<li><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the FQDN or IP address to run the test against, use
\#primary-dns or \#secondary-dns as the on-prem
primary/secondary DNS server IP.</li>
<li><strong>label</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – (Optional, for UI display only) input value label.</li>
<codeclass="descname">ID_HOSTNAME</code><emclass="property"> = 'HOSTNAME'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ID_HOSTNAME_OR_IP</code><emclass="property"> = 'HOSTNAME_OR_IP'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOSTNAME_OR_IP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ID_HOST_IP</code><emclass="property"> = 'HOST_IP'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationInput.ID_HOST_IP"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ConnectivityValidationSubGroup</code><spanclass="sig-paren">(</span><em>inputs=None</em>, <em>tests=None</em>, <em>label=None</em>, <em>help=None</em>, <em>id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>inputs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.ConnectivityValidationInput"title="com.vmware.vmc.model_client.ConnectivityValidationInput"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectivityValidationInput</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of user inputs for the sub group.</li>
<li><strong>tests</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.ConnectivityAgentValidation"title="com.vmware.vmc.model_client.ConnectivityAgentValidation"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ConnectivityAgentValidation</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of connectivity tests.</li>
<li><strong>label</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the sub-group.</li>
<li><strong>help</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Help text.</li>
<codeclass="descname">ID_ACTIVE_DIRECTORY</code><emclass="property"> = 'ACTIVE_DIRECTORY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ACTIVE_DIRECTORY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ID_ONPREM_ESX</code><emclass="property"> = 'ONPREM_ESX'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_ESX"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ID_ONPREM_PSC</code><emclass="property"> = 'ONPREM_PSC'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_PSC"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ID_ONPREM_VCENTER</code><emclass="property"> = 'ONPREM_VCENTER'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_ONPREM_VCENTER"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ID_PRIMARY_DNS</code><emclass="property"> = 'PRIMARY_DNS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_PRIMARY_DNS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ID_SECONDARY_DNS</code><emclass="property"> = 'SECONDARY_DNS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ConnectivityValidationSubGroup.ID_SECONDARY_DNS"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">CrlCertificates</code><spanclass="sig-paren">(</span><em>crl_certificate=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.CrlCertificates"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DashboardData</code><spanclass="sig-paren">(</span><em>firewall=None</em>, <em>sslvpn=None</em>, <em>interfaces=None</em>, <em>load_balancer=None</em>, <em>ipsec=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DashboardData"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DashboardStat</code><spanclass="sig-paren">(</span><em>timestamp=None</em>, <em>value=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DashboardStat"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DashboardStatistics</code><spanclass="sig-paren">(</span><em>data_dto=None</em>, <em>meta_dto=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DashboardStatistics"title="Permalink to this definition">¶</a></dt>
<li><strong>meta_dto</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.MetaDashboardStats"title="com.vmware.vmc.model_client.MetaDashboardStats"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MetaDashboardStats</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Start time, end time and interval details.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DataPageEdgeSummary</code><spanclass="sig-paren">(</span><em>paging_info=None</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DataPageEdgeSummary"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DataPageSddcNetwork</code><spanclass="sig-paren">(</span><em>paging_info=None</em>, <em>data=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DataPageSddcNetwork"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DataPermissions</code><spanclass="sig-paren">(</span><em>save_permission=None</em>, <em>publish_permission=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DataPermissions"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DhcpLeaseInfo</code><spanclass="sig-paren">(</span><em>host_lease_info_dtos=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DhcpLeaseInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>host_lease_info_dtos</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.HostLeaseInfo"title="com.vmware.vmc.model_client.HostLeaseInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">HostLeaseInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DHCP leases.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.DhcpLeases">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DhcpLeases</code><spanclass="sig-paren">(</span><em>time_stamp=None</em>, <em>host_lease_infos_dto=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DhcpLeases"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>time_stamp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The timestamp of the DHCP lease. format: int64</li>
<li><strong>logging</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.Logging"title="com.vmware.vmc.model_client.Logging"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Logging</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – DNS logging setting.</li>
<li><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if feature is enabled. Default value is true.
Optional.</li>
<li><strong>dns_views</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.DnsViews"title="com.vmware.vmc.model_client.DnsViews"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DnsViews</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS views.</li>
<li><strong>listeners</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.DnsListeners"title="com.vmware.vmc.model_client.DnsListeners"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DnsListeners</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS listeners.</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Version number tracking each configuration change. To avoid
problems with overwriting changes, always retrieve and modify the
latest configuration to include the current version number in your
request. If you provide a version number which is not current, the
request is rejected. If you omit the version number, the request is
accepted but may overwrite any current changes if your change is
not in sync with the latest change. format: int64</li>
<li><strong>cache_size</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The cache size of the DNS service. format: int64</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DnsForwarders</code><spanclass="sig-paren">(</span><em>ip_address=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DnsForwarders"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>ip_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IP addresses of the DNS servers.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.DnsListeners">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DnsListeners</code><spanclass="sig-paren">(</span><em>ip_address=None</em>, <em>vnic=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DnsListeners"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>ip_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of IP addresses.</li>
<li><strong>vnic</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Vnic for DNS listener.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DnsStatusAndStats</code><spanclass="sig-paren">(</span><em>time_stamp=None</em>, <em>requests=None</em>, <em>responses=None</em>, <em>cached_dbrr_set=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DnsStatusAndStats"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DnsView</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>view_match=None</em>, <em>recursion=None</em>, <em>view_id=None</em>, <em>forwarders=None</em>, <em>enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DnsView"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of the DNS view.</li>
<li><strong>view_match</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.DnsViewMatch"title="com.vmware.vmc.model_client.DnsViewMatch"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DnsViewMatch</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Rules that match the DNS query to this view. The rule can be
ipAddress, or ipSet. Defaults to ipAddress ‘any’ and ‘any’ vnic.</li>
<li><strong>recursion</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Recursion enabled on DNS view.</li>
<li><strong>view_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier for the DNS view.</li>
<li><strong>forwarders</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.DnsForwarders"title="com.vmware.vmc.model_client.DnsForwarders"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DnsForwarders</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – DNS forwarders.</li>
<li><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – DNS view is enabled.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.DnsViewMatch">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DnsViewMatch</code><spanclass="sig-paren">(</span><em>vnic=None</em>, <em>ip_set=None</em>, <em>ip_address=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DnsViewMatch"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>vnic</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>ip_set</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>ip_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.DnsViews">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">DnsViews</code><spanclass="sig-paren">(</span><em>dns_view=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.DnsViews"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>dns_view</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DnsView"title="com.vmware.vmc.model_client.DnsView"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DnsView</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of DNS views.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.EdgeJob">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">EdgeJob</code><spanclass="sig-paren">(</span><em>status=None</em>, <em>edge_id=None</em>, <em>module=None</em>, <em>job_id=None</em>, <em>error_code=None</em>, <em>result=None</em>, <em>start_time=None</em>, <em>message=None</em>, <em>end_time=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.EdgeJob"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>pre_rules_exists</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if pre rules publish is enabled.</li>
<li><strong>timestamp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Timestamp value at which the NSX Edge healthcheck was done. format:
int64</li>
<li><strong>publish_status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Status of the latest configuration change for the NSX Edge. Values
are APPLIED or PERSISTED (not published to NSX Edge Appliance yet).</li>
<li><strong>last_published_pre_rules_generation_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value of the last published pre rules generation number. format:
int64</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Version number of the current configuration. format: int64</li>
<li><strong>edge_vm_status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.EdgeVmStatus"title="com.vmware.vmc.model_client.EdgeVmStatus"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EdgeVmStatus</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Detailed status of each of the deployed NSX Edge appliances.</li>
<li><strong>active_vse_ha_index</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Index of the active NSX Edge appliance. Values are 0 and 1. format:
int32</li>
<li><strong>system_status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – System status of the active NSX Edge appliance.</li>
<li><strong>ha_vnic_in_use</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Index of the vnic consumed for NSX Edge HA. format: int32</li>
<li><strong>edge_status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – NSX Edge appliance health status identified by GREY (unknown
status), GREEN (health checks are successful), YELLOW (intermittent
health check failure), RED (none of the appliances are in serving
state). If health check fails for 5 consecutive times for all
appliance (2 for HA else 1) then status will turn from YELLOW to
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>feature_capabilities</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.FeatureCapabilities"title="com.vmware.vmc.model_client.FeatureCapabilities"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FeatureCapabilities</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of Features and their capability details based on Edge
appliance form factor.</li>
<li><strong>edge_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – NSX Edge type, whether ‘gatewayServices’ or ‘distributedRouter’.</li>
<li><strong>logical_router_scopes</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.LogicalRouterScopes"title="com.vmware.vmc.model_client.LogicalRouterScopes"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LogicalRouterScopes</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Backing type scope (DistributedVirtualSwitch - VLAN, TransportZone
-VXLAN) and its ID for the Distributed Logical Router.</li>
<li><strong>recent_job_info</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.EdgeJob"title="com.vmware.vmc.model_client.EdgeJob"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EdgeJob</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Job information for the most recent configuration change carried
<li><strong>edge_assist_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – ID generated by NSX Manager for Distributed Logical Router only.
format: int64</li>
<li><strong>edge_status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – NSX Edge appliance health status identified by GREY (unknown
status), GREEN (health checks are successful), YELLOW (intermittent
health check failure), RED (none of the appliances are in serving
state). If health check fails for 5 consecutive times for all
appliance (2 for HA else 1) then status will turn from YELLOW to
RED.</li>
<li><strong>edge_assist_instance_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name derived by NSX Manager only for Distributed Logical Router.</li>
<li><strong>datacenter_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Datacenter name where the NSX Edge is deployed.</li>
<li><strong>state</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Deployment state of the NSX Edge appliance. Values are ‘deployed’
when VMs have been deployed, ‘undeployed’ when no VMs are deployed
and ‘active’ when Edge type is Distributed Logical Router and has
no appliance deployed but is serving data path.</li>
<li><strong>extended_attributes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.ExtendedAttribute"title="com.vmware.vmc.model_client.ExtendedAttribute"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ExtendedAttribute</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>local_egress_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if local egress is enabled for UDLR traffic.
Applicable only for Universal Distributed Logical Router.</li>
<li><strong>is_upgrade_available</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if NSX Edge upgrade is available.</li>
<li><strong>api_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – REST API version applicable for the NSX Edge.</li>
<li><strong>tenant_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Tenant ID for the NSX Edge.</li>
<li><strong>datacenter_moid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vCenter MOID of the datacenter where the NSX Edge is deployed.</li>
<li><strong>number_of_connected_vnics</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of connected vnics that are configured on the NSX Edge.
format: int32</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.EdgeVmStatus">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">EdgeVmStatus</code><spanclass="sig-paren">(</span><em>index=None</em>, <em>ha_state=None</em>, <em>name=None</em>, <em>id=None</em>, <em>edge_vm_status=None</em>, <em>pre_rules_generation_number=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.EdgeVmStatus"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>index</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – High Availability index of the appliance. Values are 0 and 1.
format: int32</li>
<li><strong>ha_state</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – High Availability state of the appliance. Values are active and
standby.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the NSX Edge appliance.</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vCenter MOID of the NSX Edge appliance.</li>
<li><strong>edge_vm_status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – NSX Edge appliance health status identified by GREY (unknown
status), GREEN (health checks are successful), YELLOW (intermittent
health check failure), RED (appliance not in serving state).</li>
<li><strong>pre_rules_generation_number</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value of the last published pre rules generation number. format:
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">EdgeVnicAddressGroup</code><spanclass="sig-paren">(</span><em>subnet_prefix_length=None</em>, <em>secondary_addresses=None</em>, <em>primary_address=None</em>, <em>subnet_mask=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.EdgeVnicAddressGroup"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>subnet_prefix_length</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Subnet prefix length of the primary IP address.</li>
<li><strong>secondary_addresses</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.SecondaryAddresses"title="com.vmware.vmc.model_client.SecondaryAddresses"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SecondaryAddresses</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Secondary IP addresses of the NSX Edge vnic address group.
Optional.</li>
<li><strong>primary_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Primary IP address of the vnic interface. Required.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">EdgeVnicAddressGroups</code><spanclass="sig-paren">(</span><em>address_groups=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.EdgeVnicAddressGroups"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>address_groups</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.EdgeVnicAddressGroup"title="com.vmware.vmc.model_client.EdgeVnicAddressGroup"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EdgeVnicAddressGroup</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Address group configuration of the NSX Edge vnic. Vnic can be
configured to have more than one address group/subnets.</td>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ErrorResponse</code><spanclass="sig-paren">(</span><em>status=None</em>, <em>path=None</em>, <em>retryable=None</em>, <em>error_code=None</em>, <em>error_messages=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ErrorResponse"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">EsxConfig</code><spanclass="sig-paren">(</span><em>availability_zone=None</em>, <em>esxs=None</em>, <em>cluster_id=None</em>, <em>num_hosts=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.EsxConfig"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>availability_zone</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Availability zone where the hosts should be provisioned. (Can be
specified only for privileged host operations).</li>
<li><strong>esxs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>cluster_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – An optional cluster id if the esxs operation has to be on a
<li><strong>availability_zone</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Availability zone where the host is provisioned.</li>
<codeclass="descname">ESX_STATE_DELETED</code><emclass="property"> = 'DELETED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ESX_STATE_DELETING</code><emclass="property"> = 'DELETING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DELETING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ESX_STATE_DEPLOYING</code><emclass="property"> = 'DEPLOYING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_DEPLOYING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ESX_STATE_FAILED</code><emclass="property"> = 'FAILED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ESX_STATE_PROVISIONED</code><emclass="property"> = 'PROVISIONED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_PROVISIONED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ESX_STATE_READY</code><emclass="property"> = 'READY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.EsxHost.ESX_STATE_READY"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ExtendedAttribute</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>value=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ExtendedAttribute"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">FeatureCapabilities</code><spanclass="sig-paren">(</span><em>timestamp=None</em>, <em>feature_capabilities=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.FeatureCapabilities"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>timestamp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Time stamp value at which the feature capabilities were retrieved.
format: int64</li>
<li><strong>feature_capabilities</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.FeatureCapability"title="com.vmware.vmc.model_client.FeatureCapability"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FeatureCapability</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of feature capability information.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">FeatureCapability</code><spanclass="sig-paren">(</span><em>configuration_limits=None</em>, <em>is_supported=None</em>, <em>service=None</em>, <em>permission=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.FeatureCapability"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>configuration_limits</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.KeyValueAttributes"title="com.vmware.vmc.model_client.KeyValueAttributes"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">KeyValueAttributes</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of key value pairs describing the feature configuration
limits.</li>
<li><strong>is_supported</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if feature is supported on NSX Edge.</li>
<li><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the feature or service.</li>
<li><strong>permission</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.LicenceAclPermissions"title="com.vmware.vmc.model_client.LicenceAclPermissions"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">LicenceAclPermissions</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Licence and access control information for the feature.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">FeatureStatus</code><spanclass="sig-paren">(</span><em>status=None</em>, <em>configured=None</em>, <em>server_status=None</em>, <em>publish_status=None</em>, <em>service=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.FeatureStatus"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Status of the feature or service.</li>
<li><strong>configured</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if feature is configured.</li>
<li><strong>server_status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Server status of the feature or service. Values are up and down.</li>
<li><strong>publish_status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Publish status of the feature, whether APPLIED or PERSISTED.</li>
<li><strong>service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the feature or service.</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Version number tracking each configuration change. To avoid
problems with overwriting changes, always retrieve and modify the
latest configuration to include the current version number in your
request. If you provide a version number which is not current, the
request is rejected. If you omit the version number, the request is
accepted but may overwrite any current changes if your change is
not in sync with the latest change. format: int64</li>
<li><strong>global_config</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.FirewallGlobalConfig"title="com.vmware.vmc.model_client.FirewallGlobalConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FirewallGlobalConfig</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Global configuration applicable to all rules.</li>
<li><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if feature is enabled. Default value is true.
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">FirewallDashboardStats</code><spanclass="sig-paren">(</span><em>connections=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallDashboardStats"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">FirewallDefaultPolicy</code><spanclass="sig-paren">(</span><em>action=None</em>, <em>logging_enabled=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallDefaultPolicy"title="Permalink to this definition">¶</a></dt>
<li><strong>services</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.FirewallService"title="com.vmware.vmc.model_client.FirewallService"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FirewallService</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – list of protocols and ports for this firewall rule</li>
<li><strong>revision</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – current revision of the list of firewall rules, used to protect
against concurrent modification (first writer wins) format: int32
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<codeclass="descname">ACTION_ALLOW</code><emclass="property"> = 'ALLOW'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRule.ACTION_ALLOW"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ACTION_DENY</code><emclass="property"> = 'DENY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRule.ACTION_DENY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RULE_TYPE_DEFAULT</code><emclass="property"> = 'DEFAULT'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_DEFAULT"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RULE_TYPE_USER</code><emclass="property"> = 'USER'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRule.RULE_TYPE_USER"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">FirewallRuleScope</code><spanclass="sig-paren">(</span><em>grouping_object_ids=None</em>, <em>vnic_group_ids=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_EXTERNAL</code><emclass="property"> = 'external'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_EXTERNAL"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_INTERNAL</code><emclass="property"> = 'internal'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_INTERNAL"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VNIC_INDEX_0</code><emclass="property"> = 'vnic-index-0'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_0"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VNIC_INDEX_1</code><emclass="property"> = 'vnic-index-1'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_1"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VNIC_INDEX_2</code><emclass="property"> = 'vnic-index-2'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_2"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VNIC_INDEX_3</code><emclass="property"> = 'vnic-index-3'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_3"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VNIC_INDEX_4</code><emclass="property"> = 'vnic-index-4'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_4"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VNIC_INDEX_5</code><emclass="property"> = 'vnic-index-5'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_5"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VNIC_INDEX_6</code><emclass="property"> = 'vnic-index-6'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_6"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VNIC_INDEX_7</code><emclass="property"> = 'vnic-index-7'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_7"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VNIC_INDEX_8</code><emclass="property"> = 'vnic-index-8'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_8"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VNIC_INDEX_9</code><emclass="property"> = 'vnic-index-9'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VNIC_INDEX_9"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">VNIC_GROUP_IDS_VSE</code><emclass="property"> = 'vse'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleScope.VNIC_GROUP_IDS_VSE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">FirewallRuleStats</code><spanclass="sig-paren">(</span><em>timestamp=None</em>, <em>connection_count=None</em>, <em>byte_count=None</em>, <em>packet_count=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRuleStats"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">FirewallRules</code><spanclass="sig-paren">(</span><em>firewall_rules=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallRules"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">FirewallService</code><spanclass="sig-paren">(</span><em>protocol=None</em>, <em>ports=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.FirewallService"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>protocol</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – protocol name, such as ‘tcp’, ‘udp’ etc.</li>
<li><strong>ports</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – a list of port numbers and port ranges, such as {80, 91-95, 99}. If
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">GatewayTemplate</code><spanclass="sig-paren">(</span><em>public_ip=None</em>, <em>primary_dns=None</em>, <em>secondary_dns=None</em>, <em>firewall_rules=None</em>, <em>vpns=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.GatewayTemplate"title="Permalink to this definition">¶</a></dt>
<li><strong>firewall_rules</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.FirewallRule"title="com.vmware.vmc.model_client.FirewallRule"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FirewallRule</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vpns</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.Vpn"title="com.vmware.vmc.model_client.Vpn"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Vpn</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.GlcmBundle">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">GlcmBundle</code><spanclass="sig-paren">(</span><em>s3_bucket=None</em>, <em>id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.GlcmBundle"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>mac_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – MAC address of the client.</li>
<li><strong>ends</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – End time of the lease.</li>
<li><strong>abandoned</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Time stamp of when IP address was marked as abandoned.</li>
<li><strong>cltt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Client Last Transaction Time of the lease info.</li>
<li><strong>client_hostname</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the client.</li>
<li><strong>starts</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Start time of the lease.</li>
<li><strong>hardware_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The hardware type on which the lease will be used.</li>
<li><strong>tsfp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Time Sent From Partner of the lease info.</li>
<li><strong>uid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Uid to identify the DHCP lease.</li>
<li><strong>next_binding_state</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Indicates what state the lease will move to when the current state
expires.</li>
<li><strong>ip_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IP address of the client.</li>
<li><strong>tstp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Time Sent To Partner of the lease info.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">InteractionPermissions</code><spanclass="sig-paren">(</span><em>manage_permission=None</em>, <em>view_permission=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.InteractionPermissions"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>vnic7_in_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic0_in_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic8_out_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic5_in_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic2_in_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic3_in_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic6_out_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic3_in_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic8_in_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic1_in_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic1_out_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic5_out_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic0_out_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic0_out_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic6_out_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic3_out_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic7_in_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic1_out_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic9_out_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic9_in_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic4_in_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic5_out_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic2_out_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic2_in_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic5_in_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic7_out_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic3_out_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic4_out_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic4_out_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic1_in_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic2_out_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic6_in_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic0_in_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic9_in_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic7_out_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic4_in_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic9_out_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic8_out_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic8_in_byte</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>vnic6_in_pkt</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.IpAddresses">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">IpAddresses</code><spanclass="sig-paren">(</span><em>ip_address=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.IpAddresses"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>ip_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of IP addresses.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Ipsec">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Ipsec</code><spanclass="sig-paren">(</span><em>feature_type=None</em>, <em>logging=None</em>, <em>global_=None</em>, <em>enabled=None</em>, <em>sites=None</em>, <em>disable_event=None</em>, <em>version=None</em>, <em>template=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Ipsec"title="Permalink to this definition">¶</a></dt>
<li><strong>logging</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.Logging"title="com.vmware.vmc.model_client.Logging"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Logging</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Configure logging for the feature on NSX Edge appliance. Logging is
disabled by default. Optional.</li>
<li><strong>global</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.IpsecGlobalConfig"title="com.vmware.vmc.model_client.IpsecGlobalConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpsecGlobalConfig</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IPsec Global configuration details.</li>
<li><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if feature is enabled. Default value is true.
Optional.</li>
<li><strong>sites</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.IpsecSites"title="com.vmware.vmc.model_client.IpsecSites"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">IpsecSites</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IPsec Site configuration details.</li>
<li><strong>disable_event</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Enable/disable event generation on NSX Edge appliance for IPsec.</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Version number tracking each configuration change. To avoid
problems with overwriting changes, always retrieve and modify the
latest configuration to include the current version number in your
request. If you provide a version number which is not current, the
request is rejected. If you omit the version number, the request is
accepted but may overwrite any current changes if your change is
not in sync with the latest change. format: int64</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">IpsecDashboardStats</code><spanclass="sig-paren">(</span><em>ipsec_bytes_out=None</em>, <em>ipsec_bytes_in=None</em>, <em>ipsec_tunnels=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.IpsecDashboardStats"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">IpsecGlobalConfig</code><spanclass="sig-paren">(</span><em>psk=None</em>, <em>ca_certificates=None</em>, <em>service_certificate=None</em>, <em>crl_certificates=None</em>, <em>extension=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.IpsecGlobalConfig"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>psk</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IPsec Global Pre Shared Key. Maximum characters is 128. Required
when peerIp is configured as ‘any’ in NSX Edge IPsec Site
configuration.</li>
<li><strong>ca_certificates</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.CaCertificates"title="com.vmware.vmc.model_client.CaCertificates"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">CaCertificates</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – CA certificate list. Optional.</li>
<li><strong>service_certificate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Certificate name or identifier. Required when x.509 is selected as
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>psk</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Pre Shared Key for the IPsec Site. Required if Site peerIp is not
‘any’. Global PSK is used when Authentication mode is PSK and Site
peerIp is ‘any’.</li>
<li><strong>local_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Local ID of the IPsec Site. Defaults to the local IP.</li>
<li><strong>enable_pfs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Enable/disable Perfect Forward Secrecy. Default is true.</li>
<li><strong>authentication_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Authentication mode for the IPsec Site. Valid values are psk and
x.509, with psk as default.</li>
<li><strong>peer_subnets</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.Subnets"title="com.vmware.vmc.model_client.Subnets"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Subnets</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Peer subnets for which IPsec VPN is configured.</li>
<li><strong>dh_group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Diffie-Hellman algorithm group. Defaults to DH14 for FIPS enabled
NSX Edge. DH2 and DH5 are not supported when FIPS is enabled on NSX
Edge. Valid values are DH2, DH5, DH14, DH15, DH16.</li>
<li><strong>site_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – ID of the IPsec Site configuration provided by NSX Manager.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of the IPsec Site.</li>
<li><strong>peer_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IP (IPv4) address or FQDN of the Peer. Can also be specified as
‘any’. Required.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the IPsec Site.</li>
<li><strong>local_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Local IP of the IPsec Site. Should be one of the IP addresses
configured on the uplink interfaces of the NSX Edge. Required.</li>
<li><strong>encryption_algorithm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IPsec encryption algorithm with default as aes256. Valid values are
<li><strong>mtu</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – MTU for the IPsec site. Defaults to the mtu of the NSX Edge vnic
specified by the localIp. Optional. format: int32</li>
<li><strong>peer_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Peer ID. Should be unique for all IPsec Site’s configured for an
NSX Edge.</li>
<li><strong>local_subnets</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.Subnets"title="com.vmware.vmc.model_client.Subnets"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Subnets</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Local subnets for which IPsec VPN is configured.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">IpsecSiteStats</code><spanclass="sig-paren">(</span><em>rx_bytes_on_site=None</em>, <em>tunnel_stats=None</em>, <em>ike_status=None</em>, <em>site_status=None</em>, <em>tx_bytes_from_site=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.IpsecSiteStats"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">IpsecSites</code><spanclass="sig-paren">(</span><em>sites=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.IpsecSites"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">IpsecStatusAndStats</code><spanclass="sig-paren">(</span><em>time_stamp=None</em>, <em>server_status=None</em>, <em>site_statistics=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.IpsecStatusAndStats"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">KeyValueAttributes</code><spanclass="sig-paren">(</span><em>value=None</em>, <em>key=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.KeyValueAttributes"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value corresponding to the key of the configuration limit
parameter.</li>
<li><strong>key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Key name of the configuration limit parameter.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">KmsVpcEndpoint</code><spanclass="sig-paren">(</span><em>vpc_endpoint_id=None</em>, <em>network_interface_ids=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.KmsVpcEndpoint"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>vpc_endpoint_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The identifier of the VPC endpoint created to AWS Key Management
Service</li>
<li><strong>network_interface_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">L2Extension</code><spanclass="sig-paren">(</span><em>tunnel_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.L2Extension"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">L2Vpn</code><spanclass="sig-paren">(</span><em>enabled=None</em>, <em>sites=None</em>, <em>listener_ip=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.L2Vpn"title="Permalink to this definition">¶</a></dt>
<li><strong>listener_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Public uplink ip address. IP of external interface on which L2VPN
service listens to.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.L2vpnStats">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">L2vpnStats</code><spanclass="sig-paren">(</span><em>tunnel_status=None</em>, <em>established_date=None</em>, <em>name=None</em>, <em>dropped_rx_packets=None</em>, <em>encryption_algorithm=None</em>, <em>failure_message=None</em>, <em>tx_bytes_from_local_subnet=None</em>, <em>rx_bytes_on_local_subnet=None</em>, <em>dropped_tx_packets=None</em>, <em>last_updated_time=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.L2vpnStats"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>tunnel_status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Status of the tunnel (UP/DOWN).</li>
<li><strong>established_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Tunnel established date. format: int64</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – User defined name of the site.</li>
<li><strong>dropped_rx_packets</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of received packets dropped.</li>
<li><strong>encryption_algorithm</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cipher used in encryption.</li>
<li><strong>failure_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Reason for the tunnel down.</li>
<li><strong>tx_bytes_from_local_subnet</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of bytes transferred from local subnet.</li>
<li><strong>rx_bytes_on_local_subnet</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of bytes received on the local subnet.</li>
<li><strong>dropped_tx_packets</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of transferred packets dropped.</li>
<li><strong>last_updated_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Time stamp of the statistics collection. format: int64</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">L2vpnStatusAndStats</code><spanclass="sig-paren">(</span><em>time_stamp=None</em>, <em>server_status=None</em>, <em>site_stats=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.L2vpnStatusAndStats"title="Permalink to this definition">¶</a></dt>
<li><strong>site_stats</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.L2vpnStats"title="com.vmware.vmc.model_client.L2vpnStats"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">L2vpnStats</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of statistics for each Site.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">LicenceAclPermissions</code><spanclass="sig-paren">(</span><em>data_permission=None</em>, <em>is_licensed=None</em>, <em>access_permission=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.LicenceAclPermissions"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>data_permission</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.DataPermissions"title="com.vmware.vmc.model_client.DataPermissions"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataPermissions</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Data access control information for the feature.</li>
<li><strong>is_licensed</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if feature is licenced.</li>
<li><strong>access_permission</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.InteractionPermissions"title="com.vmware.vmc.model_client.InteractionPermissions"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">InteractionPermissions</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Access control information for the feature.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">LoadBalancerDashboardStats</code><spanclass="sig-paren">(</span><em>lb_bps_in=None</em>, <em>lb_http_reqs=None</em>, <em>lb_bps_out=None</em>, <em>lb_sessions=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.LoadBalancerDashboardStats"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>lb_bps_in</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of bytes in.</li>
<li><strong>lb_http_reqs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of HTTP requests received by Load Balancer.</li>
<li><strong>lb_bps_out</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of bytes out.</li>
<li><strong>lb_sessions</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of Load Balancer sessions.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Logging">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Logging</code><spanclass="sig-paren">(</span><em>log_level=None</em>, <em>enable=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Logging"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>subnet_cidr</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the subnet cidr</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – name of the network</li>
<li><strong>gateway_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – gateway ip of the logical network</li>
<li><strong>dhcp_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – if ‘true’ - enabled; if ‘false’ - disabled</li>
<li><strong>dhcp_ip_range</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – ip range within the subnet mask, range delimiter is ‘-‘ (example
10.118.10.130-10.118.10.140)</li>
<li><strong>tunnel_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – tunnel id of extended network format: int32</li>
<codeclass="descname">NETWORK_TYPE_EXTENDED</code><emclass="property"> = 'EXTENDED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_EXTENDED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NETWORK_TYPE_HOSTED</code><emclass="property"> = 'HOSTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_HOSTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">NETWORK_TYPE_ROUTED</code><emclass="property"> = 'ROUTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.LogicalNetwork.NETWORK_TYPE_ROUTED"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">LogicalRouterScope</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.LogicalRouterScope"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">LogicalRouterScopes</code><spanclass="sig-paren">(</span><em>logical_router_scope=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.LogicalRouterScopes"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">MacAddress</code><spanclass="sig-paren">(</span><em>edge_vm_ha_index=None</em>, <em>value=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.MacAddress"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">MaintenanceWindow</code><spanclass="sig-paren">(</span><em>day_of_week=None</em>, <em>hour_of_day=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindow"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_FRIDAY</code><emclass="property"> = 'FRIDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_FRIDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_MONDAY</code><emclass="property"> = 'MONDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_MONDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_SATURDAY</code><emclass="property"> = 'SATURDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_SATURDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_SUNDAY</code><emclass="property"> = 'SUNDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_SUNDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_THURSDAY</code><emclass="property"> = 'THURSDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_THURSDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_TUESDAY</code><emclass="property"> = 'TUESDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_TUESDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_WEDNESDAY</code><emclass="property"> = 'WEDNESDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindow.DAY_OF_WEEK_WEDNESDAY"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">MaintenanceWindowEntry</code><spanclass="sig-paren">(</span><em>in_maintenance_window=None</em>, <em>reservation_schedule=None</em>, <em>reservation_id=None</em>, <em>in_maintenance_mode=None</em>, <em>sddc_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindowEntry"title="Permalink to this definition">¶</a></dt>
<li><strong>in_maintenance_window</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – true if the SDDC is in the defined Mainentance Window</li>
<li><strong>reservation_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – ID for reservation format: uuid</li>
<li><strong>in_maintenance_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – true if the SDDC is currently undergoing maintenance</li>
<li><strong>sddc_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SDDC ID for this reservation format: uuid</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">MaintenanceWindowGet</code><spanclass="sig-paren">(</span><em>day_of_week=None</em>, <em>hour_of_day=None</em>, <em>duration_min=None</em>, <em>version=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindowGet"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_FRIDAY</code><emclass="property"> = 'FRIDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_FRIDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_MONDAY</code><emclass="property"> = 'MONDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_MONDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_SATURDAY</code><emclass="property"> = 'SATURDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_SATURDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_SUNDAY</code><emclass="property"> = 'SUNDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_SUNDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_THURSDAY</code><emclass="property"> = 'THURSDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_THURSDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_TUESDAY</code><emclass="property"> = 'TUESDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_TUESDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_WEDNESDAY</code><emclass="property"> = 'WEDNESDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.MaintenanceWindowGet.DAY_OF_WEEK_WEDNESDAY"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ManagementGatewayTemplate</code><spanclass="sig-paren">(</span><em>public_ip=None</em>, <em>primary_dns=None</em>, <em>secondary_dns=None</em>, <em>firewall_rules=None</em>, <em>vpns=None</em>, <em>subnet_cidr=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ManagementGatewayTemplate"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">MapZonesRequest</code><spanclass="sig-paren">(</span><em>connected_account_id=None</em>, <em>org_id=None</em>, <em>petronas_regions_to_map=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.MapZonesRequest"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>connected_account_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The connected account ID to remap. This is a standard UUID.</li>
<li><strong>org_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The org ID to remap in. This is a standard UUID.</li>
<li><strong>petronas_regions_to_map</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A list of Petronas regions to map.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">MetaDashboardStats</code><spanclass="sig-paren">(</span><em>vnics=None</em>, <em>end_time=None</em>, <em>start_time=None</em>, <em>interval=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.MetaDashboardStats"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>vnics</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.Vnic"title="com.vmware.vmc.model_client.Vnic"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Vnic</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Statistics data is collected for these vNICs.</li>
<li><strong>end_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – End time in seconds. format: int64</li>
<li><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Start time in seconds. format: int64</li>
<li><strong>interval</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Time interval in seconds. format: int32</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Metadata">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Metadata</code><spanclass="sig-paren">(</span><em>timestamp=None</em>, <em>cycle_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Metadata"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>timestamp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the timestamp for the bundle</li>
<li><strong>cycle_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the cycle id</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Nat">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Nat</code><spanclass="sig-paren">(</span><em>rules=None</em>, <em>feature_type=None</em>, <em>version=None</em>, <em>enabled=None</em>, <em>template=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Nat"title="Permalink to this definition">¶</a></dt>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Version number tracking each configuration change. To avoid
problems with overwriting changes, always retrieve and modify the
latest configuration to include the current version number in your
request. If you provide a version number which is not current, the
request is rejected. If you omit the version number, the request is
accepted but may overwrite any current changes if your change is
not in sync with the latest change. format: int64</li>
<li><strong>enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if feature is enabled. Default value is true.
<li><strong>revision</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – current revision of the list of nat rules, used to protect against
<codeclass="descname">ACTION_DNAT</code><emclass="property"> = 'dnat'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.NatRule.ACTION_DNAT"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ACTION_SNAT</code><emclass="property"> = 'snat'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.NatRule.ACTION_SNAT"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.NatRules">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">NatRules</code><spanclass="sig-paren">(</span><em>nat_rules_dtos=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.NatRules"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">NetworkTemplate</code><spanclass="sig-paren">(</span><em>management_gateway_templates=None</em>, <em>compute_gateway_templates=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.NetworkTemplate"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>rule_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifies the type of the rule. internal_high or user.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description for the rule</li>
<li><strong>rule_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier for the rule. format: int64</li>
<li><strong>match_translated</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Defines the order of NAT and Firewall pipeline. When false,
<li><strong>direction</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Direction. Possible values in or out. Default is ‘any’.</li>
<li><strong>statistics</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.FirewallRuleStats"title="com.vmware.vmc.model_client.FirewallRuleStats"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">FirewallRuleStats</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Statistics for the rule</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name for the rule.</li>
<li><strong>logging_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Enable logging for the rule.</li>
<li><strong>destination</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.AddressFWSourceDestination"title="com.vmware.vmc.model_client.AddressFWSourceDestination"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddressFWSourceDestination</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of destinations. Default is any.</li>
<li><strong>application</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.Application"title="com.vmware.vmc.model_client.Application"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Application</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of applications. Default is any.</li>
<li><strong>source</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.AddressFWSourceDestination"title="com.vmware.vmc.model_client.AddressFWSourceDestination"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AddressFWSourceDestination</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of sources. Default is any.</li>
<li><strong>rule_tag</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Rule tag. Used to specify user-defined ruleId. If not specified NSX
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Nsxfirewallservice</code><spanclass="sig-paren">(</span><em>source_port=None</em>, <em>protocol=None</em>, <em>port=None</em>, <em>icmp_type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Nsxfirewallservice"title="Permalink to this definition">¶</a></dt>
<li><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of destination ports.</li>
<li><strong>icmp_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IcmpType. Only supported when protocol is icmp. Default is ‘any’.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Nsxl2vpn">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Nsxl2vpn</code><spanclass="sig-paren">(</span><em>listener_ips=None</em>, <em>enabled=None</em>, <em>sites=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Nsxl2vpn"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>vnic</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Interface on which the NAT rule is applied.</li>
<li><strong>rule_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifies the type of the rule. internal_high or user.</li>
<li><strong>protocol</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Protocol. Default is ‘any’</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description for the rule.</li>
<li><strong>rule_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier for the rule. format: int64</li>
<li><strong>snat_match_destination_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Apply SNAT rule only if traffic has this destination port. Default
is ‘any’.</li>
<li><strong>original_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Original address or address range. This is the original source
address for SNAT rules and the original destination address for
DNAT rules.</li>
<li><strong>dnat_match_source_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Apply DNAT rule only if traffic has this source address. Default is
‘any’.</li>
<li><strong>dnat_match_source_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Apply DNAT rule only if traffic has this source port. Default is
‘any’.</li>
<li><strong>snat_match_destination_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Apply SNAT rule only if traffic has this destination address.
Default is ‘any’.</li>
<li><strong>original_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Original port. This is the original source port for SNAT rules, and
the original destination port for DNAT rules.</li>
<li><strong>logging_enabled</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Enable logging for the rule.</li>
<li><strong>translated_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Translated address or address range.</li>
<li><strong>icmp_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – ICMP type. Only supported when protocol is icmp. Default is ‘any’.</li>
<li><strong>translated_port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Translated port. Supported in DNAT rules only.</li>
<li><strong>action</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Action for the rule. SNAT or DNAT.</li>
<li><strong>rule_tag</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Rule tag. Used to specify user-defined ruleId. If not specified NSX
Manager will generate ruleId. format: int64</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Nsxsite">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Nsxsite</code><spanclass="sig-paren">(</span><em>secure_traffic=None</em>, <em>site_id=None</em>, <em>name=None</em>, <em>password=None</em>, <em>user_id=None</em>, <em>description=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Nsxsite"title="Permalink to this definition">¶</a></dt>
<li><strong>site_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Identifier for L2 VPN site.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of L2 VPN site. Length: 1-255 characters.</li>
<li><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Password for L2 VPN user. Passwords must contain the following:
12-63 characters, a mix of upper case letters, lower case letters,
numbers, and at least one special character. Password must not
contain the username as a substring. Do not repeat a character 3 or
more times.</li>
<li><strong>user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – L2 VPN user ID. Valid user names: 1-63 characters, letters and
numbers only. No white space or special characters.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Description of L2 VPN site.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.ObjectType">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ObjectType</code><spanclass="sig-paren">(</span><em>name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ObjectType"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">OfferInstancesHolder</code><spanclass="sig-paren">(</span><em>on_demand=None</em>, <em>offers=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.OfferInstancesHolder"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">OfferType</code><spanclass="sig-paren">(</span><em>string</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.OfferType"title="Permalink to this definition">¶</a></dt>
<pclass="last">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
enumerated type in communication with a server that supports the newer
version of the API, you instantiate this class. See <aclass="reference internal"href="enumeration.html#enumeration-description"><spanclass="std std-ref">enumerated
<codeclass="descname">ON_DEMAND</code><emclass="property"> = OfferType(string='ON_DEMAND')</em><aclass="headerlink"href="#com.vmware.vmc.model_client.OfferType.ON_DEMAND"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TERM</code><emclass="property"> = OfferType(string='TERM')</em><aclass="headerlink"href="#com.vmware.vmc.model_client.OfferType.TERM"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">OrgProperties</code><spanclass="sig-paren">(</span><em>values=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.OrgProperties"title="Permalink to this definition">¶</a></dt>
<li><strong>user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>updated_by_user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Version of this entity format: int32</li>
<li><strong>updated_by_user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – User name that last updated this record</li>
<li><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique ID for this entity</li>
<li><strong>org_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – ORG_TYPE to be associated with the org</li>
<codeclass="descname">PROJECT_STATE_CREATED</code><emclass="property"> = 'CREATED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Organization.PROJECT_STATE_CREATED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PROJECT_STATE_DELETED</code><emclass="property"> = 'DELETED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Organization.PROJECT_STATE_DELETED"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">PagedEdgeList</code><spanclass="sig-paren">(</span><em>edge_page=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.PagedEdgeList"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>edge_page</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.DataPageEdgeSummary"title="com.vmware.vmc.model_client.DataPageEdgeSummary"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DataPageEdgeSummary</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Page details with matched records.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.PagingInfo">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">PagingInfo</code><spanclass="sig-paren">(</span><em>sort_order_ascending=None</em>, <em>total_count=None</em>, <em>start_index=None</em>, <em>sort_by=None</em>, <em>page_size=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.PagingInfo"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">PopAmiInfo</code><spanclass="sig-paren">(</span><em>region=None</em>, <em>id=None</em>, <em>name=None</em>, <em>type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.PopAmiInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>region</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the region of the esx ami</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the ami id for the esx</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the name of the esx ami</li>
<codeclass="descname">TYPE_CENTOS</code><emclass="property"> = 'CENTOS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopAmiInfo.TYPE_CENTOS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TYPE_POP</code><emclass="property"> = 'POP'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopAmiInfo.TYPE_POP"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.PopInfo">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">PopInfo</code><spanclass="sig-paren">(</span><em>ami_infos=None</em>, <em>created_at=None</em>, <em>id=None</em>, <em>service_infos=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.PopInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>ami_infos</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vmc.model_client.PopAmiInfo"title="com.vmware.vmc.model_client.PopAmiInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PopAmiInfo</span></code></a>) – A map of [region name of PoP / PoP-AMI]:[PopAmiInfo].</li>
<li><strong>created_at</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The PopInfo (or PoP AMI) created time. Using ISO 8601 date-time
pattern. format: date-time</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – UUID of the PopInfo format: UUID</li>
<li><strong>service_infos</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <aclass="reference internal"href="#com.vmware.vmc.model_client.PopServiceInfo"title="com.vmware.vmc.model_client.PopServiceInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">PopServiceInfo</span></code></a>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A map of [service type]:[PopServiceInfo]</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">PopServiceInfo</code><spanclass="sig-paren">(</span><em>cln=None</em>, <em>version=None</em>, <em>build=None</em>, <em>service=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>cln</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The service change set number.</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The service API version.</li>
<li><strong>build</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The service build number.</li>
<codeclass="descname">SERVICE_AGENT</code><emclass="property"> = 'AGENT'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AGENT"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_AIDE</code><emclass="property"> = 'AIDE'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_AIDE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_BRE</code><emclass="property"> = 'BRE'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_BRF</code><emclass="property"> = 'BRF'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_BRF"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_DNS</code><emclass="property"> = 'DNS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DNS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_DOCKER</code><emclass="property"> = 'DOCKER'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_DOCKER"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_FM_LOG_COLLECTOR</code><emclass="property"> = 'FM_LOG_COLLECTOR'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_LOG_COLLECTOR"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_FM_MANAGEMENT</code><emclass="property"> = 'FM_MANAGEMENT'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_MANAGEMENT"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_FM_METRICS_COLLECTOR</code><emclass="property"> = 'FM_METRICS_COLLECTOR'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FM_METRICS_COLLECTOR"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_FORWARD_PROXY</code><emclass="property"> = 'FORWARD_PROXY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_FORWARD_PROXY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_GLCM</code><emclass="property"> = 'GLCM'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_GLCM"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_JRE</code><emclass="property"> = 'JRE'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_JRE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_LOGZ_LOG_COLLECTOR</code><emclass="property"> = 'LOGZ_LOG_COLLECTOR'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_LOGZ_LOG_COLLECTOR"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_NTP</code><emclass="property"> = 'NTP'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_NTP"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_OS</code><emclass="property"> = 'OS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_OS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_REVERSE_PROXY</code><emclass="property"> = 'REVERSE_PROXY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_REVERSE_PROXY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_RTS</code><emclass="property"> = 'RTS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_RTS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SERVICE_S3_ADAPTER</code><emclass="property"> = 'S3_ADAPTER'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.PopServiceInfo.SERVICE_S3_ADAPTER"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Requests">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Requests</code><spanclass="sig-paren">(</span><em>total=None</em>, <em>queries=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Requests"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Reservation</code><spanclass="sig-paren">(</span><em>duration=None</em>, <em>rid=None</em>, <em>create_time=None</em>, <em>start_time=None</em>, <em>metadata=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Reservation"title="Permalink to this definition">¶</a></dt>
<li><strong>start_time</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Start time of a reservation format: date-time</li>
<li><strong>metadata</strong> ((<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">dict</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> and <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Optional</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ReservationInMw</code><spanclass="sig-paren">(</span><em>rid=None</em>, <em>week_of=None</em>, <em>create_time=None</em>, <em>metadata=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationInMw"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>rid</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Reservation ID format: uuid</li>
<li><strong>week_of</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – SUNDAY of the week that maintenance is scheduled, ISO format date</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ReservationSchedule</code><spanclass="sig-paren">(</span><em>day_of_week=None</em>, <em>hour_of_day=None</em>, <em>duration_min=None</em>, <em>version=None</em>, <em>reservations=None</em>, <em>reservations_mw=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationSchedule"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_FRIDAY</code><emclass="property"> = 'FRIDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_FRIDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_MONDAY</code><emclass="property"> = 'MONDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_MONDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_SATURDAY</code><emclass="property"> = 'SATURDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_SATURDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_SUNDAY</code><emclass="property"> = 'SUNDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_SUNDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_THURSDAY</code><emclass="property"> = 'THURSDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_THURSDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_TUESDAY</code><emclass="property"> = 'TUESDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_TUESDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DAY_OF_WEEK_WEDNESDAY</code><emclass="property"> = 'WEDNESDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationSchedule.DAY_OF_WEEK_WEDNESDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RESERVATION_STATE_CANCELED</code><emclass="property"> = 'CANCELED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_CANCELED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RESERVATION_STATE_COMPLETED</code><emclass="property"> = 'COMPLETED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_COMPLETED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RESERVATION_STATE_RUNNING</code><emclass="property"> = 'RUNNING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_RUNNING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">RESERVATION_STATE_SCHEDULED</code><emclass="property"> = 'SCHEDULED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationWindow.RESERVATION_STATE_SCHEDULED"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ReservationWindowMaintenanceProperties</code><spanclass="sig-paren">(</span><em>status=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ReservationWindowMaintenanceProperties"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>status</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Status of upgrade, if any</td>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Result</code><spanclass="sig-paren">(</span><em>value=None</em>, <em>key=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Result"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>value</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Job Result value associated with key ID.</li>
<li><strong>key</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Job Result key ID.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.ScopeInfo">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ScopeInfo</code><spanclass="sig-paren">(</span><em>object_type_name=None</em>, <em>id=None</em>, <em>name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ScopeInfo"title="Permalink to this definition">¶</a></dt>
<li><strong>user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>updated_by_user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Version of this entity format: int32</li>
<li><strong>updated_by_user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – User name that last updated this record</li>
<li><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique ID for this entity</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – name for SDDC</li>
<li><strong>expiration_date</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">datetime.datetime</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Expiration date of a sddc in UTC (will be set if its applicable)
<li><strong>sddc_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Type of the sddc</li>
<codeclass="descname">ACCOUNT_LINK_STATE_DELAYED</code><emclass="property"> = 'DELAYED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_DELAYED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ACCOUNT_LINK_STATE_LINKED</code><emclass="property"> = 'LINKED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_LINKED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ACCOUNT_LINK_STATE_UNLINKED</code><emclass="property"> = 'UNLINKED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Sddc.ACCOUNT_LINK_STATE_UNLINKED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PROVIDER_AWS</code><emclass="property"> = 'AWS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Sddc.PROVIDER_AWS"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SDDC_STATE_DELETED</code><emclass="property"> = 'DELETED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SDDC_STATE_DELETING</code><emclass="property"> = 'DELETING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SDDC_STATE_DELETION_FAILED</code><emclass="property"> = 'DELETION_FAILED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DELETION_FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SDDC_STATE_DEPLOYING</code><emclass="property"> = 'DEPLOYING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_DEPLOYING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SDDC_STATE_FAILED</code><emclass="property"> = 'FAILED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">SDDC_STATE_READY</code><emclass="property"> = 'READY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Sddc.SDDC_STATE_READY"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcAllocatePublicIpSpec</code><spanclass="sig-paren">(</span><em>count=None</em>, <em>private_ips=None</em>, <em>names=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcAllocatePublicIpSpec"title="Permalink to this definition">¶</a></dt>
<li><strong>private_ips</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of workload VM private IPs to be assigned the public IP just
allocated.</li>
<li><strong>names</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of names for the workload VM public IP assignment.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.SddcConfig">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcConfig</code><spanclass="sig-paren">(</span><em>name=None</em>, <em>account_link_sddc_config=None</em>, <em>vpc_cidr=None</em>, <em>num_hosts=None</em>, <em>sddc_type=None</em>, <em>vxlan_subnet=None</em>, <em>account_link_config=None</em>, <em>provider='SddcConfig'</em>, <em>sso_domain=None</em>, <em>sddc_template_id=None</em>, <em>deployment_type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcConfig"title="Permalink to this definition">¶</a></dt>
<li><strong>account_link_sddc_config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.AccountLinkSddcConfig"title="com.vmware.vmc.model_client.AccountLinkSddcConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AccountLinkSddcConfig</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A list of the SDDC linking configurations to use.</li>
<li><strong>vpc_cidr</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – AWS VPC IP range. Only prefix of 16 or 20 is currently supported.</li>
<li><strong>sddc_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Denotes the sddc type , if the value is null or empty, the type is
considered as default.</li>
<li><strong>vxlan_subnet</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – VXLAN IP subnet</li>
<li><strong>account_link_config</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.AccountLinkConfig"title="com.vmware.vmc.model_client.AccountLinkConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AccountLinkConfig</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The account linking configuration, we will keep this one and remove
<p>Determines what additional properties are available based on cloud
provider.</p>
</li>
<li><strong>sso_domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO domain name to use for vSphere users. If not specified,
vmc.local will be used.</li>
<li><strong>sddc_template_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If provided, configuration from the template will applied to the
<codeclass="descname">DEPLOYMENT_TYPE_MULTIAZ</code><emclass="property"> = 'MultiAZ'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_MULTIAZ"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEPLOYMENT_TYPE_SINGLEAZ</code><emclass="property"> = 'SingleAZ'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcConfig.DEPLOYMENT_TYPE_SINGLEAZ"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PROVIDER_AWS</code><emclass="property"> = 'AWS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcConfig.PROVIDER_AWS"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcId</code><spanclass="sig-paren">(</span><em>sddc_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcId"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcLinkConfig</code><spanclass="sig-paren">(</span><em>customer_subnet_ids=None</em>, <em>connected_account_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcLinkConfig"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>customer_subnet_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>connected_account_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Determines which connected customer account to link to</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.SddcManifest">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcManifest</code><spanclass="sig-paren">(</span><em>vmc_version=None</em>, <em>glcm_bundle=None</em>, <em>pop_info=None</em>, <em>vmc_internal_version=None</em>, <em>esx_ami=None</em>, <em>esx_nsxt_ami=None</em>, <em>metadata=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcManifest"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>vmc_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the vmcVersion of the sddc for display</li>
<li><strong>vmc_internal_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – the vmcInternalVersion of the sddc for internal use</li>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>subnets</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.SddcNetworkAddressGroups"title="com.vmware.vmc.model_client.SddcNetworkAddressGroups"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SddcNetworkAddressGroups</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Network address groups for routed logical networks.</li>
<li><strong>cgw_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the compute gateway to which the logical network is
attached.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Name of logical network. Length needs to be between 1-35
characters.</li>
<li><strong>l2_extension</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.L2Extension"title="com.vmware.vmc.model_client.L2Extension"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">L2Extension</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Layer 2 extension for extended logical networks.</li>
<li><strong>cgw_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – ID of the compute gateway edge to which the logical network is
attached.</li>
<li><strong>dhcp_configs</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.SddcNetworkDhcpConfig"title="com.vmware.vmc.model_client.SddcNetworkDhcpConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SddcNetworkDhcpConfig</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – DHCP configuration for routed logical networks.</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – ID of logical network.</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcNetworkAddressGroup</code><spanclass="sig-paren">(</span><em>prefix_length=None</em>, <em>primary_address=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcNetworkAddressGroup"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcNetworkAddressGroups</code><spanclass="sig-paren">(</span><em>address_groups=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcNetworkAddressGroups"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcNetworkDhcpConfig</code><spanclass="sig-paren">(</span><em>ip_pools=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcNetworkDhcpConfig"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>ip_pools</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.SddcNetworkDhcpIpPool"title="com.vmware.vmc.model_client.SddcNetworkDhcpIpPool"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SddcNetworkDhcpIpPool</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of IP pools in DHCP configuration.</td>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcNetworkDhcpIpPool</code><spanclass="sig-paren">(</span><em>ip_range=None</em>, <em>domain_name=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcNetworkDhcpIpPool"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>ip_range</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – IP range for DHCP IP pool.</li>
<li><strong>domain_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – DNS domain name.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.SddcPublicIp">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcPublicIp</code><spanclass="sig-paren">(</span><em>public_ip=None</em>, <em>name=None</em>, <em>allocation_id=None</em>, <em>dnat_rule_id=None</em>, <em>associated_private_ip=None</em>, <em>snat_rule_id=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcPublicIp"title="Permalink to this definition">¶</a></dt>
<li><strong>mgmt_appliance_network_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name for management appliance network.</li>
<li><strong>dns_with_management_vm_private_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – if true, use the private IP addresses to register DNS records for
<li><strong>psc_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – URL of the PSC server</li>
<li><strong>cgws</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>availability_zones</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Availability zones over which esx hosts are provisioned. MultiAZ
SDDCs will have hosts provisioned over two availability zones while
SingleAZ SDDCs will provision over one.</li>
<li><strong>management_ds</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ManagedObjectReference of the management Datastore</li>
<div>Discriminator for additional properties</div></blockquote>
</li>
<li><strong>clusters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.struct.VapiStruct</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of clusters in the SDDC.
When clients pass a value of this class as a parameter, the
attribute must contain all the attributes defined in
<aclass="reference internal"href="#com.vmware.vmc.model_client.Cluster"title="com.vmware.vmc.model_client.Cluster"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster</span></code></a>. When methods return a value of this class as a
return value, the attribute will contain all the attributes defined
in <aclass="reference internal"href="#com.vmware.vmc.model_client.Cluster"title="com.vmware.vmc.model_client.Cluster"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">Cluster</span></code></a>.</li>
<li><strong>vc_instance_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – unique id of the vCenter server</li>
<li><strong>esx_cluster_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Cluster Id to add ESX workflow</li>
<li><strong>vc_public_ip</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – vCenter public IP</li>
<li><strong>vc_url</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – URL of the vCenter server</li>
<li><strong>vxlan_subnet</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – VXLAN IP subnet</li>
<li><strong>cloud_user_group</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Group name for vCenter SDDC administrator</li>
<li><strong>witness_availability_zone</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Availability zone where the witness node is provisioned for a
MultiAZ SDDC. This is null for a SingleAZ SDDC.</li>
<li><strong>sso_domain</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The SSO domain name to use for vSphere users</li>
<codeclass="descname">DEPLOYMENT_TYPE_MULTI_AZ</code><emclass="property"> = 'MULTI_AZ'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_MULTI_AZ"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DEPLOYMENT_TYPE_SINGLE_AZ</code><emclass="property"> = 'SINGLE_AZ'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcResourceConfig.DEPLOYMENT_TYPE_SINGLE_AZ"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">PROVIDER_AWS</code><emclass="property"> = 'AWS'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcResourceConfig.PROVIDER_AWS"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SddcStateRequest</code><spanclass="sig-paren">(</span><em>sddcs=None</em>, <em>states=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcStateRequest"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATES_CANCELED</code><emclass="property"> = 'CANCELED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_CANCELED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATES_COMPLETED</code><emclass="property"> = 'COMPLETED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_COMPLETED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATES_RUNNING</code><emclass="property"> = 'RUNNING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_RUNNING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATES_SCHEDULED</code><emclass="property"> = 'SCHEDULED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcStateRequest.STATES_SCHEDULED"title="Permalink to this definition">¶</a></dt>
<li><strong>user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>updated_by_user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Version of this entity format: int32</li>
<li><strong>updated_by_user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – User name that last updated this record</li>
<li><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique ID for this entity</li>
<li><strong>account_link_sddc_configs</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.AccountLinkSddcConfig"title="com.vmware.vmc.model_client.AccountLinkSddcConfig"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">AccountLinkSddcConfig</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – A list of the SDDC linking configurations to use.</li>
<codeclass="descname">STATE_APPLIED</code><emclass="property"> = 'APPLIED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcTemplate.STATE_APPLIED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATE_AVAILABLE</code><emclass="property"> = 'AVAILABLE'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcTemplate.STATE_AVAILABLE"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATE_DELETED</code><emclass="property"> = 'DELETED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATE_DELETING</code><emclass="property"> = 'DELETING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcTemplate.STATE_DELETING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATE_FAILED</code><emclass="property"> = 'FAILED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcTemplate.STATE_FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATE_INITIALIZING</code><emclass="property"> = 'INITIALIZING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcTemplate.STATE_INITIALIZING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATE_INUSE</code><emclass="property"> = 'INUSE'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SddcTemplate.STATE_INUSE"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SecondaryAddresses</code><spanclass="sig-paren">(</span><em>type=None</em>, <em>ip_address=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SecondaryAddresses"title="Permalink to this definition">¶</a></dt>
<li><strong>ip_address</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of IP addresses.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.ServiceError">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">ServiceError</code><spanclass="sig-paren">(</span><em>original_service=None</em>, <em>params=None</em>, <em>default_message=None</em>, <em>original_service_error_code=None</em>, <em>error_code=None</em>, <em>localized_message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.ServiceError"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>original_service</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The original service name of the error.</li>
<li><strong>params</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The parameters of the service error.</li>
<li><strong>default_message</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Error message in English.</li>
<li><strong>original_service_error_code</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The original error code of the service.</li>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>password</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Site password.</li>
<li><strong>user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Site user id.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Unique name for the site getting configured.</li>
<li><strong>rx_bytes_on_local_subnet</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Bytes received on local network. format: int64
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>dropped_tx_packets</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of transmitted packets dropped.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<li><strong>dropped_rx_packets</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of received packets dropped.
This attribute may be present in responses from the server, but if
it is present in a request to server it will be ignored.</li>
<codeclass="descname">TUNNEL_STATUS_CONNECTED</code><emclass="property"> = 'CONNECTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Site.TUNNEL_STATUS_CONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TUNNEL_STATUS_DISCONNECTED</code><emclass="property"> = 'DISCONNECTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Site.TUNNEL_STATUS_DISCONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TUNNEL_STATUS_UNKNOWN</code><emclass="property"> = 'UNKNOWN'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Site.TUNNEL_STATUS_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Sites">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Sites</code><spanclass="sig-paren">(</span><em>sites=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Sites"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SslvpnDashboardStats</code><spanclass="sig-paren">(</span><em>active_clients=None</em>, <em>sslvpn_bytes_in=None</em>, <em>auth_failures=None</em>, <em>sessions_created=None</em>, <em>sslvpn_bytes_out=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SslvpnDashboardStats"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>active_clients</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of active clients.</li>
<li><strong>sslvpn_bytes_in</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Rx bytes received for SSL VPN.</li>
<li><strong>auth_failures</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of authentication failures.</li>
<li><strong>sessions_created</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Number of SSL VPN sessions created.</li>
<li><strong>sslvpn_bytes_out</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.DashboardStat"title="com.vmware.vmc.model_client.DashboardStat"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">DashboardStat</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Tx bytes transmitted for SSL VPN.</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.StubFactory">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>index</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Index of the sub interface assigned by NSX Manager. Min value is 10
and max value is 4103. format: int32</li>
<li><strong>tunnel_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Valid values for tunnel ID are min 1 to max 4093. Required. format:
int32</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the sub interface. Required.</li>
<li><strong>address_groups</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.EdgeVnicAddressGroups"title="com.vmware.vmc.model_client.EdgeVnicAddressGroups"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EdgeVnicAddressGroups</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Address group configuration of the sub interface.</li>
<li><strong>vlan_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – VLAN ID of the virtual LAN used by this sub interface. VLAN IDs can
range from 0 to 4094. format: int32</li>
<li><strong>label</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Sub interface label of format vNic_{index} provided by NSX Manager.
Read only.</li>
<li><strong>logical_switch_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the logical switch connected to this sub interface.</li>
<li><strong>is_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if the sub interface is connected to a logical
switch, standard portgroup or distributed portgroup.</li>
<li><strong>mtu</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – MTU value of the sub interface. This value would be the least mtu
for all the trunk interfaces of the NSX Edge. Default is 1500.
format: int32</li>
<li><strong>logical_switch_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – ID of the logical switch connected to this sub interface.</li>
<li><strong>enable_send_redirects</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if send redirects is enabled. Enable ICMP redirect to
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SubInterfaces</code><spanclass="sig-paren">(</span><em>sub_interfaces=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SubInterfaces"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>sub_interfaces</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.SubInterface"title="com.vmware.vmc.model_client.SubInterface"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SubInterface</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of sub interfaces.</td>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>compatible</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Is this customer subnet compatible with the SDDC?</li>
<li><strong>connected_account_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ID of the connected account this subnet is from.</li>
<li><strong>region_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The region this subnet is from.</li>
<li><strong>availability_zone</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The availability zone (customer-centric) this subnet is in.</li>
<li><strong>subnet_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ID of the subnet.</li>
<li><strong>subnet_cidr_block</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The CIDR block of the subnet.</li>
<li><strong>note</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Why a subnet is marked as not compatible. May be blank if
compatible.</li>
<li><strong>vpc_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ID of the VPC this subnet resides in.</li>
<li><strong>vpc_cidr_block</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The CIDR block of the VPC containing this subnet.</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The name of the subnet. This is either the tagged name or the
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Subnets</code><spanclass="sig-paren">(</span><em>subnets=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Subnets"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>subnets</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of subnets for which IPsec VPN is configured. Subnets should
be network address specified in CIDR format and can accept
<li><strong>commitment_term_uom</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – unit of measurment for commitment term</li>
<codeclass="descname">STATUS_ACTIVATED</code><emclass="property"> = 'ACTIVATED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ACTIVATED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATUS_CANCELLED</code><emclass="property"> = 'CANCELLED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CANCELLED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATUS_CREATED</code><emclass="property"> = 'CREATED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_CREATED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATUS_EXPIRED</code><emclass="property"> = 'EXPIRED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_EXPIRED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATUS_FAILED</code><emclass="property"> = 'FAILED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATUS_ORDER_SUBMITTED</code><emclass="property"> = 'ORDER_SUBMITTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_ORDER_SUBMITTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATUS_PENDING_PROVISIONING</code><emclass="property"> = 'PENDING_PROVISIONING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SubscriptionDetails.STATUS_PENDING_PROVISIONING"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">SubscriptionRequest</code><spanclass="sig-paren">(</span><em>offer_version=None</em>, <em>product_type=None</em>, <em>region=None</em>, <em>commitment_term=None</em>, <em>offer_name=None</em>, <em>quantity=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.SubscriptionRequest"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">START_DAY_FRIDAY</code><emclass="property"> = 'FRIDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_FRIDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">START_DAY_MONDAY</code><emclass="property"> = 'MONDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_MONDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">START_DAY_SATURDAY</code><emclass="property"> = 'SATURDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_SATURDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">START_DAY_SUNDAY</code><emclass="property"> = 'SUNDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_SUNDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">START_DAY_THURSDAY</code><emclass="property"> = 'THURSDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_THURSDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">START_DAY_TUESDAY</code><emclass="property"> = 'TUESDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_TUESDAY"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">START_DAY_WEDNESDAY</code><emclass="property"> = 'WEDNESDAY'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.SupportWindow.START_DAY_WEDNESDAY"title="Permalink to this definition">¶</a></dt>
<li><strong>user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>updated_by_user_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User id that last updated this record</li>
<li><strong>version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Version of this entity format: int32</li>
<li><strong>updated_by_user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – User name that last updated this record</li>
<li><strong>user_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – User name that last updated this record</li>
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Unique ID for this entity</li>
<li><strong>estimated_remaining_minutes</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Estimated remaining time in minute of the task execution, < 0 means
<li><strong>start_resource_entity_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Entity version of the resource at the start of the task. This is
<li><strong>end_resource_entity_version</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Entity version of the resource at the end of the task. This is only
set for some task types. format: int32</li>
<li><strong>service_errors</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.ServiceError"title="com.vmware.vmc.model_client.ServiceError"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">ServiceError</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Service errors returned from SDDC services.</li>
<li><strong>parent_task_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If this task was created by another task - this provides the
<li><strong>phase_in_progress</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The current in progress phase ID in the task execution, if none in
progress, empty string returned.</li>
<li><strong>resource_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Type of resource being acted upon</li>
<codeclass="descname">STATUS_CANCELED</code><emclass="property"> = 'CANCELED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Task.STATUS_CANCELED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATUS_CANCELING</code><emclass="property"> = 'CANCELING'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Task.STATUS_CANCELING"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATUS_FAILED</code><emclass="property"> = 'FAILED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Task.STATUS_FAILED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATUS_FINISHED</code><emclass="property"> = 'FINISHED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Task.STATUS_FINISHED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATUS_STARTED</code><emclass="property"> = 'STARTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Task.STATUS_STARTED"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">TaskProgressPhase</code><spanclass="sig-paren">(</span><em>id=None</em>, <em>name=None</em>, <em>progress_percent=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.TaskProgressPhase"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The identifier of the task progress phase</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – The display name of the task progress phase</li>
<li><strong>progress_percent</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – The percentage of the phase that has completed format: int32</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">TrafficShapingPolicy</code><spanclass="sig-paren">(</span><em>burst_size=None</em>, <em>average_bandwidth=None</em>, <em>peak_bandwidth=None</em>, <em>enabled=None</em>, <em>inherited=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.TrafficShapingPolicy"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">VmcLocale</code><spanclass="sig-paren">(</span><em>locale=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.VmcLocale"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>locale</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The locale to be used for translating responses for the session</td>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>sub_interfaces</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.SubInterfaces"title="com.vmware.vmc.model_client.SubInterfaces"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SubInterfaces</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – List of sub interfaces. Sub interfaces can be created only on a
trunk interface.</li>
<li><strong>address_groups</strong> (<aclass="reference internal"href="#com.vmware.vmc.model_client.EdgeVnicAddressGroups"title="com.vmware.vmc.model_client.EdgeVnicAddressGroups"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">EdgeVnicAddressGroups</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Address group configuration of the interface.</li>
<li><strong>is_connected</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if the vnic is connected to a logical switch,
standard portgroup or distributed portgroup.</li>
<li><strong>enable_send_redirects</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if send redirects is enabled. Enable ICMP redirect to
<li><strong>label</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Interface label of format vNic_{vnicIndex} provided by NSX Manager.
Read only.</li>
<li><strong>enable_proxy_arp</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if proxy arp is enabled. Enable proxy ARP if you want
to allow the NSX Edge of type ‘gatewayServices’ to answer ARP
requests intended for other machines.</li>
<li><strong>index</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code>) – Index of the vnic. Min value is 0 and max value is 9. format: int32</li>
<li><strong>name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the interface. Optional.</li>
<li><strong>mtu</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – MTU of the interface, with default as 1500. Min is 68, Max is 9000.
Optional. format: int32</li>
<li><strong>fence_parameters</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.KeyValueAttributes"title="com.vmware.vmc.model_client.KeyValueAttributes"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">KeyValueAttributes</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<li><strong>mac_addresses</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.MacAddress"title="com.vmware.vmc.model_client.MacAddress"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">MacAddress</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Distinct MAC addresses configured for the vnic. Optional.</li>
<li><strong>portgroup_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Name of the port group or logical switch.</li>
<li><strong>enable_bridge_mode</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value is true if bridge mode is enabled.</li>
<li><strong>type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Type of the vnic. Values are uplink, internal, trunk. At least one
internal interface must be configured for NSX Edge HA to work.</li>
<li><strong>portgroup_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Value are port group ID (standard portgroup or distributed
portgroup) or virtual wire ID (logical switch). Logical switch
cannot be used for a TRUNK vnic. Portgroup cannot be shared among
vnics/LIFs. Required when isConnected is specified as true. Example
portgroup) or ‘virtualwire-2’ (logical switch).</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dlclass="class">
<dtid="com.vmware.vmc.model_client.Vnics">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">Vnics</code><spanclass="sig-paren">(</span><em>vnics=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.Vnics"title="Permalink to this definition">¶</a></dt>
<li><strong>edge_subnet_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Id of the NSX edge associated with this VPC</li>
<li><strong>api_association_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Id of the association between subnet and route-table</li>
<li><strong>api_subnet_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Id associated with this VPC</li>
<li><strong>vgw_route_table_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Route table which contains the route to VGW</li>
<li><strong>edge_association_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Id of the association between edge subnet and route-table</li>
<li><strong>vif_ids</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">VpcInfoSubnets</code><spanclass="sig-paren">(</span><em>vpc_id=None</em>, <em>cidr_block=None</em>, <em>description=None</em>, <em>subnets=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.VpcInfoSubnets"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>vpc_id</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The ID of the VPC these subnets belong to.</li>
<li><strong>cidr_block</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The overall CIDR block of the VPC. This is the AWS primary CIDR
block.</li>
<li><strong>description</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – The description of the VPC; usually it’s name or id.</li>
<li><strong>subnets</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">list</span></code> of <aclass="reference internal"href="#com.vmware.vmc.model_client.SubnetInfo"title="com.vmware.vmc.model_client.SubnetInfo"><codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">SubnetInfo</span></code></a> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) –</li>
<codeclass="descname">AUTHENTICATION_PSK</code><emclass="property"> = 'PSK'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.AUTHENTICATION_PSK"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">AUTHENTICATION_UNKNOWN</code><emclass="property"> = 'UNKNOWN'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.AUTHENTICATION_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DH_GROUP_DH14</code><emclass="property"> = 'DH14'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH14"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DH_GROUP_DH15</code><emclass="property"> = 'DH15'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH15"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DH_GROUP_DH16</code><emclass="property"> = 'DH16'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH16"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DH_GROUP_DH2</code><emclass="property"> = 'DH2'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH2"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DH_GROUP_DH5</code><emclass="property"> = 'DH5'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_DH5"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DH_GROUP_UNKNOWN</code><emclass="property"> = 'UNKNOWN'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.DH_GROUP_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DIGEST_ALGORITHM_SHA1</code><emclass="property"> = 'SHA1'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA1"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">DIGEST_ALGORITHM_SHA_256</code><emclass="property"> = 'SHA_256'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.DIGEST_ALGORITHM_SHA_256"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ENCRYPTION_AES</code><emclass="property"> = 'AES'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ENCRYPTION_AES256</code><emclass="property"> = 'AES256'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES256"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ENCRYPTION_AES_GCM</code><emclass="property"> = 'AES_GCM'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_AES_GCM"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ENCRYPTION_TRIPLE_DES</code><emclass="property"> = 'TRIPLE_DES'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_TRIPLE_DES"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">ENCRYPTION_UNKNOWN</code><emclass="property"> = 'UNKNOWN'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.ENCRYPTION_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">IKE_OPTION_IKEV1</code><emclass="property"> = 'IKEV1'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV1"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">IKE_OPTION_IKEV2</code><emclass="property"> = 'IKEV2'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.IKE_OPTION_IKEV2"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATE_CONNECTED</code><emclass="property"> = 'CONNECTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.STATE_CONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATE_DISCONNECTED</code><emclass="property"> = 'DISCONNECTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.STATE_DISCONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATE_PARTIALLY_CONNECTED</code><emclass="property"> = 'PARTIALLY_CONNECTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.STATE_PARTIALLY_CONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">STATE_UNKNOWN</code><emclass="property"> = 'UNKNOWN'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.Vpn.STATE_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">VpnChannelStatus</code><spanclass="sig-paren">(</span><em>channel_status=None</em>, <em>channel_state=None</em>, <em>last_info_message=None</em>, <em>failure_message=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.VpnChannelStatus"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CHANNEL_STATUS_CONNECTED</code><emclass="property"> = 'CONNECTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_CONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CHANNEL_STATUS_DISCONNECTED</code><emclass="property"> = 'DISCONNECTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_DISCONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">CHANNEL_STATUS_UNKNOWN</code><emclass="property"> = 'UNKNOWN'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.VpnChannelStatus.CHANNEL_STATUS_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TUNNEL_STATUS_CONNECTED</code><emclass="property"> = 'CONNECTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_CONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TUNNEL_STATUS_DISCONNECTED</code><emclass="property"> = 'DISCONNECTED'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_DISCONNECTED"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">TUNNEL_STATUS_UNKNOWN</code><emclass="property"> = 'UNKNOWN'</em><aclass="headerlink"href="#com.vmware.vmc.model_client.VpnTunnelStatus.TUNNEL_STATUS_UNKNOWN"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.model_client.</code><codeclass="descname">VsanEncryptionConfig</code><spanclass="sig-paren">(</span><em>port=None</em>, <em>certificate=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.model_client.VsanEncryptionConfig"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><ulclass="first last simple">
<li><strong>port</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">long</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Port to connect to AWS Key Management Service</li>
<li><strong>certificate</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Public certificate used to connect to AWS Key Management Service</li>
<spanid="com-vmware-vmc-orgs-client-module"></span><h2>com.vmware.vmc.orgs_client module<aclass="headerlink"href="#module-com.vmware.vmc.orgs_client"title="Permalink to this headline">¶</a></h2>
<dlclass="class">
<dtid="com.vmware.vmc.orgs_client.AccountLink">
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.orgs_client.</code><codeclass="descname">AccountLink</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.AccountLink"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>org</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.AccountLink.get"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.orgs_client.</code><codeclass="descname">OfferInstances</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.OfferInstances"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>org</em>, <em>region</em>, <em>product_type</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.OfferInstances.list"title="Permalink to this definition">¶</a></dt>
<dd><p>List all offers available for the specific product type in the specific
<li><strong>region</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Region for the offer (required)</li>
<li><strong>product_type</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code>) – Type of the product in offers (required)</li>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.orgs_client.</code><codeclass="descname">Providers</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Providers"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>org</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Providers.list"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.orgs_client.</code><codeclass="descname">Reservations</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Reservations"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>org</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Reservations.list"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.orgs_client.</code><codeclass="descname">SddcTemplates</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.SddcTemplates"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>org</em>, <em>template_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.SddcTemplates.delete"title="Permalink to this definition">¶</a></dt>
<dd><p>Delete SDDC template identified by given id.</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>org</em>, <em>template_id</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.SddcTemplates.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get configuration template by given template id.</p>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>org</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.SddcTemplates.list"title="Permalink to this definition">¶</a></dt>
<dd><p>List all available SDDC configuration templates in an organization</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.orgs_client.</code><codeclass="descname">Sddcs</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Sddcs"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dlclass="method">
<dtid="com.vmware.vmc.orgs_client.Sddcs.create">
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>org</em>, <em>sddc_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Sddcs.create"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">delete</code><spanclass="sig-paren">(</span><em>org</em>, <em>sddc</em>, <em>retain_configuration=None</em>, <em>template_name=None</em>, <em>force=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Sddcs.delete"title="Permalink to this definition">¶</a></dt>
<li><strong>retain_configuration</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">bool</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If = ‘true’, the SDDC’s configuration is retained as a template for
later use. This flag is applicable only to SDDCs in ACTIVE state.
(optional)</li>
<li><strong>template_name</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – Only applicable when retainConfiguration is also set to ‘true’.
When set, this value will be used as the name of the SDDC
<li><strong>force</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If = ‘true’, will delete forcefully. Beware: do not use the force
flag if there is a chance an active provisioning or deleting task
is running against this SDDC. This option is restricted. (optional)</li>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>org</em>, <em>sddc</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Sddcs.get"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>org</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Sddcs.list"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.orgs_client.</code><codeclass="descname">StubFactory</code><spanclass="sig-paren">(</span><em>stub_config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.StubFactory"title="Permalink to this definition">¶</a></dt>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.orgs_client.</code><codeclass="descname">Subscriptions</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Subscriptions"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
<codeclass="descname">GET_0_OFFER_TYPE_ON_DEMAND</code><emclass="property"> = 'ON_DEMAND'</em><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Subscriptions.GET_0_OFFER_TYPE_ON_DEMAND"title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <codeclass="docutils literal notranslate"><spanclass="pre">offerType</span></code> of method <aclass="reference internal"href="#com.vmware.vmc.orgs_client.Subscriptions.get_0"title="com.vmware.vmc.orgs_client.Subscriptions.get_0"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Subscriptions.get_0()</span></code></a>.</p>
<codeclass="descname">GET_0_OFFER_TYPE_TERM</code><emclass="property"> = 'TERM'</em><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Subscriptions.GET_0_OFFER_TYPE_TERM"title="Permalink to this definition">¶</a></dt>
<dd><p>Possible value for <codeclass="docutils literal notranslate"><spanclass="pre">offerType</span></code> of method <aclass="reference internal"href="#com.vmware.vmc.orgs_client.Subscriptions.get_0"title="com.vmware.vmc.orgs_client.Subscriptions.get_0"><codeclass="xref py py-func docutils literal notranslate"><spanclass="pre">Subscriptions.get_0()</span></code></a>.</p>
<codeclass="descname">create</code><spanclass="sig-paren">(</span><em>org</em>, <em>subscription_request</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Subscriptions.create"title="Permalink to this definition">¶</a></dt>
<dd><p>Initiates the creation of a subscription</p>
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>org</em>, <em>subscription</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Subscriptions.get"title="Permalink to this definition">¶</a></dt>
<dd><p>Get subscription details for a given subscription id</p>
<codeclass="descname">get_0</code><spanclass="sig-paren">(</span><em>org</em>, <em>offer_type=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Subscriptions.get_0"title="Permalink to this definition">¶</a></dt>
<dd><p>Returns all subscriptions for a given org id</p>
<emclass="property">class </em><codeclass="descclassname">com.vmware.vmc.orgs_client.</code><codeclass="descname">Tasks</code><spanclass="sig-paren">(</span><em>config</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Tasks"title="Permalink to this definition">¶</a></dt>
<trclass="field-odd field"><thclass="field-name">Parameters:</th><tdclass="field-body"><strong>config</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">vmware.vapi.bindings.stub.StubConfiguration</span></code>) – Configuration to be used for creating the stub.</td>
</tr>
</tbody>
</table>
<dlclass="method">
<dtid="com.vmware.vmc.orgs_client.Tasks.get">
<codeclass="descname">get</code><spanclass="sig-paren">(</span><em>org</em>, <em>task</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Tasks.get"title="Permalink to this definition">¶</a></dt>
<codeclass="descname">list</code><spanclass="sig-paren">(</span><em>org</em>, <em>filter=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Tasks.list"title="Permalink to this definition">¶</a></dt>
<dd><p>List all tasks with optional filtering.</p>
<codeclass="descname">update</code><spanclass="sig-paren">(</span><em>org</em>, <em>task</em>, <em>action=None</em><spanclass="sig-paren">)</span><aclass="headerlink"href="#com.vmware.vmc.orgs_client.Tasks.update"title="Permalink to this definition">¶</a></dt>
<dd><p>Request that a running task be canceled. This is advisory only, some
tasks may not be cancelable, and some tasks might take an arbitrary
amount of time to respond to a cancelation request. The task must be
<li><strong>action</strong> (<codeclass="xref py py-class docutils literal notranslate"><spanclass="pre">str</span></code> or <codeclass="docutils literal notranslate"><spanclass="pre">None</span></code>) – If = ‘cancel’, task will be canceled (optional)</li>
Built with <ahref="http://sphinx-doc.org/">Sphinx</a> using a <ahref="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <ahref="https://readthedocs.org">Read the Docs</a>.
