vmware.vmc.console.models package

Submodules

vmware.vmc.console.models.abstract_entity module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.abstract_entity.AbstractEntity(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AbstractEntity - a model defined in OpenAPI

attribute_map = {'created': 'created', 'id': 'id', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version'}
property created

Gets the created of this AbstractEntity. # noqa: E501

Returns

The created of this AbstractEntity. # noqa: E501

Return type

datetime

property id

Gets the id of this AbstractEntity. # noqa: E501

Unique ID for this entity # noqa: E501

Returns

The id of this AbstractEntity. # noqa: E501

Return type

str

openapi_types = {'created': 'datetime', 'id': 'str', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property updated

Gets the updated of this AbstractEntity. # noqa: E501

Returns

The updated of this AbstractEntity. # noqa: E501

Return type

datetime

property updated_by_user_id

Gets the updated_by_user_id of this AbstractEntity. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The updated_by_user_id of this AbstractEntity. # noqa: E501

Return type

str

property updated_by_user_name

Gets the updated_by_user_name of this AbstractEntity. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The updated_by_user_name of this AbstractEntity. # noqa: E501

Return type

str

property user_id

Gets the user_id of this AbstractEntity. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The user_id of this AbstractEntity. # noqa: E501

Return type

str

property user_name

Gets the user_name of this AbstractEntity. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The user_name of this AbstractEntity. # noqa: E501

Return type

str

property version

Gets the version of this AbstractEntity. # noqa: E501

Version of this entity # noqa: E501

Returns

The version of this AbstractEntity. # noqa: E501

Return type

int

vmware.vmc.console.models.address_fw_source_destination module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.address_fw_source_destination.AddressFWSourceDestination(exclude=None, ip_address=None, grouping_object_id=None, vnic_group_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AddressFWSourceDestination - a model defined in OpenAPI

attribute_map = {'exclude': 'exclude', 'grouping_object_id': 'groupingObjectId', 'ip_address': 'ipAddress', 'vnic_group_id': 'vnicGroupId'}
property exclude

Gets the exclude of this AddressFWSourceDestination. # noqa: E501

Exclude the specified source or destination. # noqa: E501

Returns

The exclude of this AddressFWSourceDestination. # noqa: E501

Return type

bool

property grouping_object_id

Gets the grouping_object_id of this AddressFWSourceDestination. # noqa: E501

List of string. Id of cluster, datacenter, distributedPortGroup, legacyPortGroup, VirtualMachine, vApp, resourcePool, logicalSwitch, IPSet, securityGroup. Can define multiple. # noqa: E501

Returns

The grouping_object_id of this AddressFWSourceDestination. # noqa: E501

Return type

list[str]

property ip_address

Gets the ip_address of this AddressFWSourceDestination. # noqa: E501

List of string. Can specify single IP address, range of IP address, or in CIDR format. Can define multiple. # noqa: E501

Returns

The ip_address of this AddressFWSourceDestination. # noqa: E501

Return type

list[str]

openapi_types = {'exclude': 'bool', 'grouping_object_id': 'list[str]', 'ip_address': 'list[str]', 'vnic_group_id': 'list[str]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vnic_group_id

Gets the vnic_group_id of this AddressFWSourceDestination. # noqa: E501

List of string. Possible values are vnic-index-[1-9], vse, external or internal. Can define multiple. # noqa: E501

Returns

The vnic_group_id of this AddressFWSourceDestination. # noqa: E501

Return type

list[str]

vmware.vmc.console.models.agent module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.agent.Agent(internal_ip=None, agent_url=None, management_ip=None, hostname_verifier_enabled=None, master=None, network_netmask=None, network_gateway=None, provider=None, cert_enabled=None, agent_state=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Agent - a model defined in OpenAPI

property agent_state

Gets the agent_state of this Agent. # noqa: E501

Agent state # noqa: E501

Returns

The agent_state of this Agent. # noqa: E501

Return type

str

property agent_url

Gets the agent_url of this Agent. # noqa: E501

The accessible URL of the agent service, it is resolved to public IP address from the Internet and private IP address within SDDC # noqa: E501

Returns

The agent_url of this Agent. # noqa: E501

Return type

str

attribute_map = {'agent_state': 'agent_state', 'agent_url': 'agent_url', 'cert_enabled': 'cert_enabled', 'hostname_verifier_enabled': 'hostname_verifier_enabled', 'internal_ip': 'internal_ip', 'management_ip': 'management_ip', 'master': 'master', 'network_gateway': 'network_gateway', 'network_netmask': 'network_netmask', 'provider': 'provider'}
property cert_enabled

Gets the cert_enabled of this Agent. # noqa: E501

Boolean flag to indicate if the agent is using CA signed certificate # noqa: E501

Returns

The cert_enabled of this Agent. # noqa: E501

Return type

bool

discriminator_value_class_map = {'AwsAgent': 'AwsAgent'}
get_real_child_model(data)

Returns the real base class specified by the discriminator

property hostname_verifier_enabled

Gets the hostname_verifier_enabled of this Agent. # noqa: E501

Boolean flag to indicate if the agent is using FQDN in the certificate # noqa: E501

Returns

The hostname_verifier_enabled of this Agent. # noqa: E501

Return type

bool

property internal_ip

Gets the internal_ip of this Agent. # noqa: E501

The internal IP address of the agent which is provided by the underlying cloud provider # noqa: E501

Returns

The internal_ip of this Agent. # noqa: E501

Return type

str

property management_ip

Gets the management_ip of this Agent. # noqa: E501

The internal management IP address of the agent exposed to the SDDC, which might be different from the internal IP # noqa: E501

Returns

The management_ip of this Agent. # noqa: E501

Return type

str

property master

Gets the master of this Agent. # noqa: E501

Boolean flag to indicate if the agent is the master, only the master Agent is accessible # noqa: E501

Returns

The master of this Agent. # noqa: E501

Return type

bool

property network_gateway

Gets the network_gateway of this Agent. # noqa: E501

Network gateway of the agent # noqa: E501

Returns

The network_gateway of this Agent. # noqa: E501

Return type

str

property network_netmask

Gets the network_netmask of this Agent. # noqa: E501

Network netmask of the agent # noqa: E501

Returns

The network_netmask of this Agent. # noqa: E501

Return type

str

openapi_types = {'agent_state': 'str', 'agent_url': 'str', 'cert_enabled': 'bool', 'hostname_verifier_enabled': 'bool', 'internal_ip': 'str', 'management_ip': 'str', 'master': 'bool', 'network_gateway': 'str', 'network_netmask': 'str', 'provider': 'str'}
property provider

Gets the provider of this Agent. # noqa: E501

The cloud provider # noqa: E501

Returns

The provider of this Agent. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.ami_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ami_info.AmiInfo(instance_type=None, region=None, id=None, name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AmiInfo - a model defined in OpenAPI

attribute_map = {'id': 'id', 'instance_type': 'instance_type', 'name': 'name', 'region': 'region'}
property id

Gets the id of this AmiInfo. # noqa: E501

the ami id for the esx # noqa: E501

Returns

The id of this AmiInfo. # noqa: E501

Return type

str

property instance_type

Gets the instance_type of this AmiInfo. # noqa: E501

instance type of the esx ami # noqa: E501

Returns

The instance_type of this AmiInfo. # noqa: E501

Return type

str

property name

Gets the name of this AmiInfo. # noqa: E501

the name of the esx ami # noqa: E501

Returns

The name of this AmiInfo. # noqa: E501

Return type

str

openapi_types = {'id': 'str', 'instance_type': 'str', 'name': 'str', 'region': 'str'}
property region

Gets the region of this AmiInfo. # noqa: E501

the region of the esx ami # noqa: E501

Returns

The region of this AmiInfo. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.appliances_summary module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.appliances_summary.AppliancesSummary(data_store_moid_of_active_vse=None, enable_fips=None, host_name_of_active_vse=None, vm_build_info=None, deploy_appliances=None, communication_channel=None, vm_name_of_active_vse=None, number_of_deployed_vms=None, resource_pool_moid_of_active_vse=None, data_store_name_of_active_vse=None, vm_moid_of_active_vse=None, status_from_vse_updated_on=None, fqdn=None, appliance_size=None, resource_pool_name_of_active_vse=None, active_vse_ha_index=None, vm_version=None, host_moid_of_active_vse=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AppliancesSummary - a model defined in OpenAPI

property active_vse_ha_index

Gets the active_vse_ha_index of this AppliancesSummary. # noqa: E501

HA index of the active NSX Edge appliance. # noqa: E501

Returns

The active_vse_ha_index of this AppliancesSummary. # noqa: E501

Return type

int

property appliance_size

Gets the appliance_size of this AppliancesSummary. # noqa: E501

NSX Edge appliance size. # noqa: E501

Returns

The appliance_size of this AppliancesSummary. # noqa: E501

Return type

str

attribute_map = {'active_vse_ha_index': 'activeVseHaIndex', 'appliance_size': 'applianceSize', 'communication_channel': 'communicationChannel', 'data_store_moid_of_active_vse': 'dataStoreMoidOfActiveVse', 'data_store_name_of_active_vse': 'dataStoreNameOfActiveVse', 'deploy_appliances': 'deployAppliances', 'enable_fips': 'enableFips', 'fqdn': 'fqdn', 'host_moid_of_active_vse': 'hostMoidOfActiveVse', 'host_name_of_active_vse': 'hostNameOfActiveVse', 'number_of_deployed_vms': 'numberOfDeployedVms', 'resource_pool_moid_of_active_vse': 'resourcePoolMoidOfActiveVse', 'resource_pool_name_of_active_vse': 'resourcePoolNameOfActiveVse', 'status_from_vse_updated_on': 'statusFromVseUpdatedOn', 'vm_build_info': 'vmBuildInfo', 'vm_moid_of_active_vse': 'vmMoidOfActiveVse', 'vm_name_of_active_vse': 'vmNameOfActiveVse', 'vm_version': 'vmVersion'}
property communication_channel

Gets the communication_channel of this AppliancesSummary. # noqa: E501

Communication channel used to communicate with NSX Edge appliance. # noqa: E501

Returns

The communication_channel of this AppliancesSummary. # noqa: E501

Return type

str

property data_store_moid_of_active_vse

Gets the data_store_moid_of_active_vse of this AppliancesSummary. # noqa: E501

vCenter MOID of the active NSX Edge appliance’s data store. # noqa: E501

Returns

The data_store_moid_of_active_vse of this AppliancesSummary. # noqa: E501

Return type

str

property data_store_name_of_active_vse

Gets the data_store_name_of_active_vse of this AppliancesSummary. # noqa: E501

Datastore name of the active NSX Edge appliance. # noqa: E501

Returns

The data_store_name_of_active_vse of this AppliancesSummary. # noqa: E501

Return type

str

property deploy_appliances

Gets the deploy_appliances of this AppliancesSummary. # noqa: E501

Value is true if NSX Edge appliances are to be deployed. # noqa: E501

Returns

The deploy_appliances of this AppliancesSummary. # noqa: E501

Return type

bool

property enable_fips

Gets the enable_fips of this AppliancesSummary. # noqa: E501

Value is true if FIPS is enabled on NSX Edge appliance. # noqa: E501

Returns

The enable_fips of this AppliancesSummary. # noqa: E501

Return type

bool

property fqdn

Gets the fqdn of this AppliancesSummary. # noqa: E501

FQDN of the NSX Edge. # noqa: E501

Returns

The fqdn of this AppliancesSummary. # noqa: E501

Return type

str

property host_moid_of_active_vse

Gets the host_moid_of_active_vse of this AppliancesSummary. # noqa: E501

vCenter MOID of the active NSX Edge appliance’s host. # noqa: E501

Returns

The host_moid_of_active_vse of this AppliancesSummary. # noqa: E501

Return type

str

property host_name_of_active_vse

Gets the host_name_of_active_vse of this AppliancesSummary. # noqa: E501

Host name of the active NSX Edge appliance. # noqa: E501

Returns

The host_name_of_active_vse of this AppliancesSummary. # noqa: E501

Return type

str

property number_of_deployed_vms

Gets the number_of_deployed_vms of this AppliancesSummary. # noqa: E501

Number of deployed appliances of the NSX Edge. # noqa: E501

Returns

The number_of_deployed_vms of this AppliancesSummary. # noqa: E501

Return type

int

openapi_types = {'active_vse_ha_index': 'int', 'appliance_size': 'str', 'communication_channel': 'str', 'data_store_moid_of_active_vse': 'str', 'data_store_name_of_active_vse': 'str', 'deploy_appliances': 'bool', 'enable_fips': 'bool', 'fqdn': 'str', 'host_moid_of_active_vse': 'str', 'host_name_of_active_vse': 'str', 'number_of_deployed_vms': 'int', 'resource_pool_moid_of_active_vse': 'str', 'resource_pool_name_of_active_vse': 'str', 'status_from_vse_updated_on': 'int', 'vm_build_info': 'str', 'vm_moid_of_active_vse': 'str', 'vm_name_of_active_vse': 'str', 'vm_version': 'str'}
property resource_pool_moid_of_active_vse

Gets the resource_pool_moid_of_active_vse of this AppliancesSummary. # noqa: E501

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. # noqa: E501

Returns

The resource_pool_moid_of_active_vse of this AppliancesSummary. # noqa: E501

Return type

str

property resource_pool_name_of_active_vse

Gets the resource_pool_name_of_active_vse of this AppliancesSummary. # noqa: E501

Resource Pool/Cluster name of the active NSX Edge appliance. # noqa: E501

Returns

The resource_pool_name_of_active_vse of this AppliancesSummary. # noqa: E501

Return type

str

property status_from_vse_updated_on

Gets the status_from_vse_updated_on of this AppliancesSummary. # noqa: E501

Time stamp value when healthcheck status was last updated for the NSX Edge appliance. # noqa: E501

Returns

The status_from_vse_updated_on of this AppliancesSummary. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vm_build_info

Gets the vm_build_info of this AppliancesSummary. # noqa: E501

NSX Edge appliance build version. # noqa: E501

Returns

The vm_build_info of this AppliancesSummary. # noqa: E501

Return type

str

property vm_moid_of_active_vse

Gets the vm_moid_of_active_vse of this AppliancesSummary. # noqa: E501

vCenter MOID of the active NSX Edge appliance. # noqa: E501

Returns

The vm_moid_of_active_vse of this AppliancesSummary. # noqa: E501

Return type

str

property vm_name_of_active_vse

Gets the vm_name_of_active_vse of this AppliancesSummary. # noqa: E501

Name of the active NSX Edge appliance. # noqa: E501

Returns

The vm_name_of_active_vse of this AppliancesSummary. # noqa: E501

Return type

str

property vm_version

Gets the vm_version of this AppliancesSummary. # noqa: E501

NSX Edge appliance version. # noqa: E501

Returns

The vm_version of this AppliancesSummary. # noqa: E501

Return type

str

vmware.vmc.console.models.application module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.application.Application(application_id=None, service=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Application - a model defined in OpenAPI

property application_id

Gets the application_id of this Application. # noqa: E501

List of string. Id of service or serviceGroup groupingObject. Can define multiple. # noqa: E501

Returns

The application_id of this Application. # noqa: E501

Return type

list[str]

attribute_map = {'application_id': 'applicationId', 'service': 'service'}
openapi_types = {'application_id': 'list[str]', 'service': 'list[Nsxfirewallservice]'}
property service

Gets the service of this Application. # noqa: E501

List of protocol and ports. Can define multiple. # noqa: E501

Returns

The service of this Application. # noqa: E501

Return type

list[Nsxfirewallservice]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.available_zone_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.available_zone_info.AvailableZoneInfo(subnets=None, name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AvailableZoneInfo - a model defined in OpenAPI

attribute_map = {'name': 'name', 'subnets': 'subnets'}
property name

Gets the name of this AvailableZoneInfo. # noqa: E501

available zone name # noqa: E501

Returns

The name of this AvailableZoneInfo. # noqa: E501

Return type

str

openapi_types = {'name': 'str', 'subnets': 'list[Subnet]'}
property subnets

Gets the subnets of this AvailableZoneInfo. # noqa: E501

Returns

The subnets of this AvailableZoneInfo. # noqa: E501

Return type

list[Subnet]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_agent module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_agent.AwsAgent(instance_id=None, key_pair=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsAgent - a model defined in OpenAPI

attribute_map = {'instance_id': 'instance_id', 'key_pair': 'key_pair'}
property instance_id

Gets the instance_id of this AwsAgent. # noqa: E501

Returns

The instance_id of this AwsAgent. # noqa: E501

Return type

str

property key_pair

Gets the key_pair of this AwsAgent. # noqa: E501

Returns

The key_pair of this AwsAgent. # noqa: E501

Return type

AwsKeyPair

openapi_types = {'instance_id': 'str', 'key_pair': 'AwsKeyPair'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_agent_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_agent_all_of.AwsAgentAllOf(instance_id=None, key_pair=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsAgentAllOf - a model defined in OpenAPI

attribute_map = {'instance_id': 'instance_id', 'key_pair': 'key_pair'}
property instance_id

Gets the instance_id of this AwsAgentAllOf. # noqa: E501

Returns

The instance_id of this AwsAgentAllOf. # noqa: E501

Return type

str

property key_pair

Gets the key_pair of this AwsAgentAllOf. # noqa: E501

Returns

The key_pair of this AwsAgentAllOf. # noqa: E501

Return type

AwsKeyPair

openapi_types = {'instance_id': 'str', 'key_pair': 'AwsKeyPair'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_cloud_provider module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_cloud_provider.AwsCloudProvider(regions=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsCloudProvider - a model defined in OpenAPI

attribute_map = {'regions': 'regions'}
openapi_types = {'regions': 'list[str]'}
property regions

Gets the regions of this AwsCloudProvider. # noqa: E501

Returns

The regions of this AwsCloudProvider. # noqa: E501

Return type

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_cloud_provider_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_cloud_provider_all_of.AwsCloudProviderAllOf(regions=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsCloudProviderAllOf - a model defined in OpenAPI

attribute_map = {'regions': 'regions'}
openapi_types = {'regions': 'list[str]'}
property regions

Gets the regions of this AwsCloudProviderAllOf. # noqa: E501

Returns

The regions of this AwsCloudProviderAllOf. # noqa: E501

Return type

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_compatible_subnets module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_compatible_subnets.AwsCompatibleSubnets(customer_available_zones=None, vpc_map=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsCompatibleSubnets - a model defined in OpenAPI

attribute_map = {'customer_available_zones': 'customer_available_zones', 'vpc_map': 'vpc_map'}
property customer_available_zones

Gets the customer_available_zones of this AwsCompatibleSubnets. # noqa: E501

Returns

The customer_available_zones of this AwsCompatibleSubnets. # noqa: E501

Return type

list[str]

openapi_types = {'customer_available_zones': 'list[str]', 'vpc_map': 'dict(str, VpcInfoSubnets)'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpc_map

Gets the vpc_map of this AwsCompatibleSubnets. # noqa: E501

Returns

The vpc_map of this AwsCompatibleSubnets. # noqa: E501

Return type

dict(str, VpcInfoSubnets)

vmware.vmc.console.models.aws_customer_connected_account module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_customer_connected_account.AwsCustomerConnectedAccount(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, policy_payer_arn=None, region_to_az_to_shadow_mapping=None, org_id=None, cf_stack_name=None, state=None, account_number=None, policy_service_arn=None, policy_external_id=None, policy_payer_linked_arn=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsCustomerConnectedAccount - a model defined in OpenAPI

property account_number

Gets the account_number of this AwsCustomerConnectedAccount. # noqa: E501

Returns

The account_number of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

attribute_map = {'account_number': 'account_number', 'cf_stack_name': 'cf_stack_name', 'created': 'created', 'id': 'id', 'org_id': 'org_id', 'policy_external_id': 'policy_external_id', 'policy_payer_arn': 'policy_payer_arn', 'policy_payer_linked_arn': 'policy_payer_linked_arn', 'policy_service_arn': 'policy_service_arn', 'region_to_az_to_shadow_mapping': 'region_to_az_to_shadow_mapping', 'state': 'state', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version'}
property cf_stack_name

Gets the cf_stack_name of this AwsCustomerConnectedAccount. # noqa: E501

Returns

The cf_stack_name of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

property created

Gets the created of this AwsCustomerConnectedAccount. # noqa: E501

Returns

The created of this AwsCustomerConnectedAccount. # noqa: E501

Return type

datetime

property id

Gets the id of this AwsCustomerConnectedAccount. # noqa: E501

Unique ID for this entity # noqa: E501

Returns

The id of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

openapi_types = {'account_number': 'str', 'cf_stack_name': 'str', 'created': 'datetime', 'id': 'str', 'org_id': 'str', 'policy_external_id': 'str', 'policy_payer_arn': 'str', 'policy_payer_linked_arn': 'str', 'policy_service_arn': 'str', 'region_to_az_to_shadow_mapping': 'dict(str, dict(str, str))', 'state': 'str', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int'}
property org_id

Gets the org_id of this AwsCustomerConnectedAccount. # noqa: E501

Returns

The org_id of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

property policy_external_id

Gets the policy_external_id of this AwsCustomerConnectedAccount. # noqa: E501

Returns

The policy_external_id of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

property policy_payer_arn

Gets the policy_payer_arn of this AwsCustomerConnectedAccount. # noqa: E501

Returns

The policy_payer_arn of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

property policy_payer_linked_arn

Gets the policy_payer_linked_arn of this AwsCustomerConnectedAccount. # noqa: E501

Returns

The policy_payer_linked_arn of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

property policy_service_arn

Gets the policy_service_arn of this AwsCustomerConnectedAccount. # noqa: E501

Returns

The policy_service_arn of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

property region_to_az_to_shadow_mapping

Gets the region_to_az_to_shadow_mapping of this AwsCustomerConnectedAccount. # noqa: E501

Provides a map of regions to availability zones from the shadow account’s perspective # noqa: E501

Returns

The region_to_az_to_shadow_mapping of this AwsCustomerConnectedAccount. # noqa: E501

Return type

dict(str, dict(str, str))

property state

Gets the state of this AwsCustomerConnectedAccount. # noqa: E501

Returns

The state of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property updated

Gets the updated of this AwsCustomerConnectedAccount. # noqa: E501

Returns

The updated of this AwsCustomerConnectedAccount. # noqa: E501

Return type

datetime

property updated_by_user_id

Gets the updated_by_user_id of this AwsCustomerConnectedAccount. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The updated_by_user_id of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

property updated_by_user_name

Gets the updated_by_user_name of this AwsCustomerConnectedAccount. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The updated_by_user_name of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

property user_id

Gets the user_id of this AwsCustomerConnectedAccount. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The user_id of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

property user_name

Gets the user_name of this AwsCustomerConnectedAccount. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The user_name of this AwsCustomerConnectedAccount. # noqa: E501

Return type

str

property version

Gets the version of this AwsCustomerConnectedAccount. # noqa: E501

Version of this entity # noqa: E501

Returns

The version of this AwsCustomerConnectedAccount. # noqa: E501

Return type

int

vmware.vmc.console.models.aws_customer_connected_account_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_customer_connected_account_all_of.AwsCustomerConnectedAccountAllOf(policy_payer_arn=None, region_to_az_to_shadow_mapping=None, org_id=None, cf_stack_name=None, state=None, account_number=None, policy_service_arn=None, policy_external_id=None, policy_payer_linked_arn=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsCustomerConnectedAccountAllOf - a model defined in OpenAPI

property account_number

Gets the account_number of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Returns

The account_number of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Return type

str

attribute_map = {'account_number': 'account_number', 'cf_stack_name': 'cf_stack_name', 'org_id': 'org_id', 'policy_external_id': 'policy_external_id', 'policy_payer_arn': 'policy_payer_arn', 'policy_payer_linked_arn': 'policy_payer_linked_arn', 'policy_service_arn': 'policy_service_arn', 'region_to_az_to_shadow_mapping': 'region_to_az_to_shadow_mapping', 'state': 'state'}
property cf_stack_name

Gets the cf_stack_name of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Returns

The cf_stack_name of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Return type

str

openapi_types = {'account_number': 'str', 'cf_stack_name': 'str', 'org_id': 'str', 'policy_external_id': 'str', 'policy_payer_arn': 'str', 'policy_payer_linked_arn': 'str', 'policy_service_arn': 'str', 'region_to_az_to_shadow_mapping': 'dict(str, dict(str, str))', 'state': 'str'}
property org_id

Gets the org_id of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Returns

The org_id of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Return type

str

property policy_external_id

Gets the policy_external_id of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Returns

The policy_external_id of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Return type

str

property policy_payer_arn

Gets the policy_payer_arn of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Returns

The policy_payer_arn of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Return type

str

property policy_payer_linked_arn

Gets the policy_payer_linked_arn of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Returns

The policy_payer_linked_arn of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Return type

str

property policy_service_arn

Gets the policy_service_arn of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Returns

The policy_service_arn of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Return type

str

property region_to_az_to_shadow_mapping

Gets the region_to_az_to_shadow_mapping of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Provides a map of regions to availability zones from the shadow account’s perspective # noqa: E501

Returns

The region_to_az_to_shadow_mapping of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Return type

dict(str, dict(str, str))

property state

Gets the state of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Returns

The state of this AwsCustomerConnectedAccountAllOf. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_esx_host module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_esx_host.AwsEsxHost(internal_public_ip_pool=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsEsxHost - a model defined in OpenAPI

attribute_map = {'internal_public_ip_pool': 'internal_public_ip_pool'}
property internal_public_ip_pool

Gets the internal_public_ip_pool of this AwsEsxHost. # noqa: E501

Returns

The internal_public_ip_pool of this AwsEsxHost. # noqa: E501

Return type

list[SddcPublicIp]

openapi_types = {'internal_public_ip_pool': 'list[SddcPublicIp]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_esx_host_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_esx_host_all_of.AwsEsxHostAllOf(internal_public_ip_pool=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsEsxHostAllOf - a model defined in OpenAPI

attribute_map = {'internal_public_ip_pool': 'internal_public_ip_pool'}
property internal_public_ip_pool

Gets the internal_public_ip_pool of this AwsEsxHostAllOf. # noqa: E501

Returns

The internal_public_ip_pool of this AwsEsxHostAllOf. # noqa: E501

Return type

list[SddcPublicIp]

openapi_types = {'internal_public_ip_pool': 'list[SddcPublicIp]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_key_pair module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_key_pair.AwsKeyPair(key_name=None, key_fingerprint=None, key_material=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsKeyPair - a model defined in OpenAPI

attribute_map = {'key_fingerprint': 'key_fingerprint', 'key_material': 'key_material', 'key_name': 'key_name'}
property key_fingerprint

Gets the key_fingerprint of this AwsKeyPair. # noqa: E501

Returns

The key_fingerprint of this AwsKeyPair. # noqa: E501

Return type

str

property key_material

Gets the key_material of this AwsKeyPair. # noqa: E501

Returns

The key_material of this AwsKeyPair. # noqa: E501

Return type

str

property key_name

Gets the key_name of this AwsKeyPair. # noqa: E501

Returns

The key_name of this AwsKeyPair. # noqa: E501

Return type

str

openapi_types = {'key_fingerprint': 'str', 'key_material': 'str', 'key_name': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_kms_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_kms_info.AwsKmsInfo(amazon_resource_name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsKmsInfo - a model defined in OpenAPI

property amazon_resource_name

Gets the amazon_resource_name of this AwsKmsInfo. # noqa: E501

The ARN associated with the customer master key for this cluster. # noqa: E501

Returns

The amazon_resource_name of this AwsKmsInfo. # noqa: E501

Return type

str

attribute_map = {'amazon_resource_name': 'amazon_resource_name'}
openapi_types = {'amazon_resource_name': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_sddc_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_sddc_config.AwsSddcConfig(region=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsSddcConfig - a model defined in OpenAPI

attribute_map = {'region': 'region'}
openapi_types = {'region': 'str'}
property region

Gets the region of this AwsSddcConfig. # noqa: E501

Returns

The region of this AwsSddcConfig. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_sddc_config_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_sddc_config_all_of.AwsSddcConfigAllOf(region=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsSddcConfigAllOf - a model defined in OpenAPI

attribute_map = {'region': 'region'}
openapi_types = {'region': 'str'}
property region

Gets the region of this AwsSddcConfigAllOf. # noqa: E501

Returns

The region of this AwsSddcConfigAllOf. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.aws_sddc_connection module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_sddc_connection.AwsSddcConnection(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, cidr_block_subnet=None, connected_account_id=None, eni_group=None, subnet_id=None, cgw_present=None, org_id=None, sddc_id=None, cidr_block_vpc=None, connection_order=None, state=None, subnet_availability_zone=None, vpc_id=None, customer_eni_infos=None, default_route_table=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsSddcConnection - a model defined in OpenAPI

attribute_map = {'cgw_present': 'cgw_present', 'cidr_block_subnet': 'cidr_block_subnet', 'cidr_block_vpc': 'cidr_block_vpc', 'connected_account_id': 'connected_account_id', 'connection_order': 'connection_order', 'created': 'created', 'customer_eni_infos': 'customer_eni_infos', 'default_route_table': 'default_route_table', 'eni_group': 'eni_group', 'id': 'id', 'org_id': 'org_id', 'sddc_id': 'sddc_id', 'state': 'state', 'subnet_availability_zone': 'subnet_availability_zone', 'subnet_id': 'subnet_id', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version', 'vpc_id': 'vpc_id'}
property cgw_present

Gets the cgw_present of this AwsSddcConnection. # noqa: E501

Determines whether the CGW is present in this connection set or not. Used for multi-az deployments. # noqa: E501

Returns

The cgw_present of this AwsSddcConnection. # noqa: E501

Return type

bool

property cidr_block_subnet

Gets the cidr_block_subnet of this AwsSddcConnection. # noqa: E501

The CIDR block of the customer’s subnet this link is in. # noqa: E501

Returns

The cidr_block_subnet of this AwsSddcConnection. # noqa: E501

Return type

str

property cidr_block_vpc

Gets the cidr_block_vpc of this AwsSddcConnection. # noqa: E501

The CIDR block of the customer’s VPC. # noqa: E501

Returns

The cidr_block_vpc of this AwsSddcConnection. # noqa: E501

Return type

str

property connected_account_id

Gets the connected_account_id of this AwsSddcConnection. # noqa: E501

The corresponding connected (customer) account UUID this connection is attached to. # noqa: E501

Returns

The connected_account_id of this AwsSddcConnection. # noqa: E501

Return type

str

property connection_order

Gets the connection_order of this AwsSddcConnection. # noqa: E501

The order of the connection # noqa: E501

Returns

The connection_order of this AwsSddcConnection. # noqa: E501

Return type

int

property created

Gets the created of this AwsSddcConnection. # noqa: E501

Returns

The created of this AwsSddcConnection. # noqa: E501

Return type

datetime

property customer_eni_infos

Gets the customer_eni_infos of this AwsSddcConnection. # noqa: E501

A list of all ENIs used for this connection. # noqa: E501

Returns

The customer_eni_infos of this AwsSddcConnection. # noqa: E501

Return type

list[CustomerEniInfo]

property default_route_table

Gets the default_route_table of this AwsSddcConnection. # noqa: E501

The default routing table in the customer’s VPC. # noqa: E501

Returns

The default_route_table of this AwsSddcConnection. # noqa: E501

Return type

str

property eni_group

Gets the eni_group of this AwsSddcConnection. # noqa: E501

Which group the ENIs belongs to. (deprecated) # noqa: E501

Returns

The eni_group of this AwsSddcConnection. # noqa: E501

Return type

str

property id

Gets the id of this AwsSddcConnection. # noqa: E501

Unique ID for this entity # noqa: E501

Returns

The id of this AwsSddcConnection. # noqa: E501

Return type

str

openapi_types = {'cgw_present': 'bool', 'cidr_block_subnet': 'str', 'cidr_block_vpc': 'str', 'connected_account_id': 'str', 'connection_order': 'int', 'created': 'datetime', 'customer_eni_infos': 'list[CustomerEniInfo]', 'default_route_table': 'str', 'eni_group': 'str', 'id': 'str', 'org_id': 'str', 'sddc_id': 'str', 'state': 'str', 'subnet_availability_zone': 'str', 'subnet_id': 'str', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int', 'vpc_id': 'str'}
property org_id

Gets the org_id of this AwsSddcConnection. # noqa: E501

The org this link belongs to. # noqa: E501

Returns

The org_id of this AwsSddcConnection. # noqa: E501

Return type

str

property sddc_id

Gets the sddc_id of this AwsSddcConnection. # noqa: E501

The SDDC this link is used for. # noqa: E501

Returns

The sddc_id of this AwsSddcConnection. # noqa: E501

Return type

str

property state

Gets the state of this AwsSddcConnection. # noqa: E501

The state of the connection. # noqa: E501

Returns

The state of this AwsSddcConnection. # noqa: E501

Return type

str

property subnet_availability_zone

Gets the subnet_availability_zone of this AwsSddcConnection. # noqa: E501

Which availability zone is this connection in? # noqa: E501

Returns

The subnet_availability_zone of this AwsSddcConnection. # noqa: E501

Return type

str

property subnet_id

Gets the subnet_id of this AwsSddcConnection. # noqa: E501

The ID of the subnet this link is to. # noqa: E501

Returns

The subnet_id of this AwsSddcConnection. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property updated

Gets the updated of this AwsSddcConnection. # noqa: E501

Returns

The updated of this AwsSddcConnection. # noqa: E501

Return type

datetime

property updated_by_user_id

Gets the updated_by_user_id of this AwsSddcConnection. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The updated_by_user_id of this AwsSddcConnection. # noqa: E501

Return type

str

property updated_by_user_name

Gets the updated_by_user_name of this AwsSddcConnection. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The updated_by_user_name of this AwsSddcConnection. # noqa: E501

Return type

str

property user_id

Gets the user_id of this AwsSddcConnection. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The user_id of this AwsSddcConnection. # noqa: E501

Return type

str

property user_name

Gets the user_name of this AwsSddcConnection. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The user_name of this AwsSddcConnection. # noqa: E501

Return type

str

property version

Gets the version of this AwsSddcConnection. # noqa: E501

Version of this entity # noqa: E501

Returns

The version of this AwsSddcConnection. # noqa: E501

Return type

int

property vpc_id

Gets the vpc_id of this AwsSddcConnection. # noqa: E501

The VPC ID of the subnet this link is to. # noqa: E501

Returns

The vpc_id of this AwsSddcConnection. # noqa: E501

Return type

str

vmware.vmc.console.models.aws_sddc_connection_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_sddc_connection_all_of.AwsSddcConnectionAllOf(cidr_block_subnet=None, connected_account_id=None, eni_group=None, subnet_id=None, cgw_present=None, org_id=None, sddc_id=None, cidr_block_vpc=None, connection_order=None, state=None, subnet_availability_zone=None, vpc_id=None, customer_eni_infos=None, default_route_table=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsSddcConnectionAllOf - a model defined in OpenAPI

attribute_map = {'cgw_present': 'cgw_present', 'cidr_block_subnet': 'cidr_block_subnet', 'cidr_block_vpc': 'cidr_block_vpc', 'connected_account_id': 'connected_account_id', 'connection_order': 'connection_order', 'customer_eni_infos': 'customer_eni_infos', 'default_route_table': 'default_route_table', 'eni_group': 'eni_group', 'org_id': 'org_id', 'sddc_id': 'sddc_id', 'state': 'state', 'subnet_availability_zone': 'subnet_availability_zone', 'subnet_id': 'subnet_id', 'vpc_id': 'vpc_id'}
property cgw_present

Gets the cgw_present of this AwsSddcConnectionAllOf. # noqa: E501

Determines whether the CGW is present in this connection set or not. Used for multi-az deployments. # noqa: E501

Returns

The cgw_present of this AwsSddcConnectionAllOf. # noqa: E501

Return type

bool

property cidr_block_subnet

Gets the cidr_block_subnet of this AwsSddcConnectionAllOf. # noqa: E501

The CIDR block of the customer’s subnet this link is in. # noqa: E501

Returns

The cidr_block_subnet of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

property cidr_block_vpc

Gets the cidr_block_vpc of this AwsSddcConnectionAllOf. # noqa: E501

The CIDR block of the customer’s VPC. # noqa: E501

Returns

The cidr_block_vpc of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

property connected_account_id

Gets the connected_account_id of this AwsSddcConnectionAllOf. # noqa: E501

The corresponding connected (customer) account UUID this connection is attached to. # noqa: E501

Returns

The connected_account_id of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

property connection_order

Gets the connection_order of this AwsSddcConnectionAllOf. # noqa: E501

The order of the connection # noqa: E501

Returns

The connection_order of this AwsSddcConnectionAllOf. # noqa: E501

Return type

int

property customer_eni_infos

Gets the customer_eni_infos of this AwsSddcConnectionAllOf. # noqa: E501

A list of all ENIs used for this connection. # noqa: E501

Returns

The customer_eni_infos of this AwsSddcConnectionAllOf. # noqa: E501

Return type

list[CustomerEniInfo]

property default_route_table

Gets the default_route_table of this AwsSddcConnectionAllOf. # noqa: E501

The default routing table in the customer’s VPC. # noqa: E501

Returns

The default_route_table of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

property eni_group

Gets the eni_group of this AwsSddcConnectionAllOf. # noqa: E501

Which group the ENIs belongs to. (deprecated) # noqa: E501

Returns

The eni_group of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

openapi_types = {'cgw_present': 'bool', 'cidr_block_subnet': 'str', 'cidr_block_vpc': 'str', 'connected_account_id': 'str', 'connection_order': 'int', 'customer_eni_infos': 'list[CustomerEniInfo]', 'default_route_table': 'str', 'eni_group': 'str', 'org_id': 'str', 'sddc_id': 'str', 'state': 'str', 'subnet_availability_zone': 'str', 'subnet_id': 'str', 'vpc_id': 'str'}
property org_id

Gets the org_id of this AwsSddcConnectionAllOf. # noqa: E501

The org this link belongs to. # noqa: E501

Returns

The org_id of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

property sddc_id

Gets the sddc_id of this AwsSddcConnectionAllOf. # noqa: E501

The SDDC this link is used for. # noqa: E501

Returns

The sddc_id of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

property state

Gets the state of this AwsSddcConnectionAllOf. # noqa: E501

The state of the connection. # noqa: E501

Returns

The state of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

property subnet_availability_zone

Gets the subnet_availability_zone of this AwsSddcConnectionAllOf. # noqa: E501

Which availability zone is this connection in? # noqa: E501

Returns

The subnet_availability_zone of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

property subnet_id

Gets the subnet_id of this AwsSddcConnectionAllOf. # noqa: E501

The ID of the subnet this link is to. # noqa: E501

Returns

The subnet_id of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpc_id

Gets the vpc_id of this AwsSddcConnectionAllOf. # noqa: E501

The VPC ID of the subnet this link is to. # noqa: E501

Returns

The vpc_id of this AwsSddcConnectionAllOf. # noqa: E501

Return type

str

vmware.vmc.console.models.aws_sddc_resource_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_sddc_resource_config.AwsSddcResourceConfig(backup_restore_bucket=None, public_ip_pool=None, vpc_info=None, kms_vpc_endpoint=None, max_num_public_ip=None, account_link_sddc_config=None, vsan_encryption_config=None, vpc_info_peered_agent=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsSddcResourceConfig - a model defined in OpenAPI

Gets the account_link_sddc_config of this AwsSddcResourceConfig. # noqa: E501

Returns

The account_link_sddc_config of this AwsSddcResourceConfig. # noqa: E501

Return type

list[SddcLinkConfig]

attribute_map = {'account_link_sddc_config': 'account_link_sddc_config', 'backup_restore_bucket': 'backup_restore_bucket', 'kms_vpc_endpoint': 'kms_vpc_endpoint', 'max_num_public_ip': 'max_num_public_ip', 'public_ip_pool': 'public_ip_pool', 'vpc_info': 'vpc_info', 'vpc_info_peered_agent': 'vpc_info_peered_agent', 'vsan_encryption_config': 'vsan_encryption_config'}
property backup_restore_bucket

Gets the backup_restore_bucket of this AwsSddcResourceConfig. # noqa: E501

Returns

The backup_restore_bucket of this AwsSddcResourceConfig. # noqa: E501

Return type

str

property kms_vpc_endpoint

Gets the kms_vpc_endpoint of this AwsSddcResourceConfig. # noqa: E501

Returns

The kms_vpc_endpoint of this AwsSddcResourceConfig. # noqa: E501

Return type

KmsVpcEndpoint

property max_num_public_ip

Gets the max_num_public_ip of this AwsSddcResourceConfig. # noqa: E501

maximum number of public IP that user can allocate. # noqa: E501

Returns

The max_num_public_ip of this AwsSddcResourceConfig. # noqa: E501

Return type

int

openapi_types = {'account_link_sddc_config': 'list[SddcLinkConfig]', 'backup_restore_bucket': 'str', 'kms_vpc_endpoint': 'KmsVpcEndpoint', 'max_num_public_ip': 'int', 'public_ip_pool': 'list[SddcPublicIp]', 'vpc_info': 'VpcInfo', 'vpc_info_peered_agent': 'VpcInfo', 'vsan_encryption_config': 'VsanEncryptionConfig'}
property public_ip_pool

Gets the public_ip_pool of this AwsSddcResourceConfig. # noqa: E501

Returns

The public_ip_pool of this AwsSddcResourceConfig. # noqa: E501

Return type

list[SddcPublicIp]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpc_info

Gets the vpc_info of this AwsSddcResourceConfig. # noqa: E501

Returns

The vpc_info of this AwsSddcResourceConfig. # noqa: E501

Return type

VpcInfo

property vpc_info_peered_agent

Gets the vpc_info_peered_agent of this AwsSddcResourceConfig. # noqa: E501

Returns

The vpc_info_peered_agent of this AwsSddcResourceConfig. # noqa: E501

Return type

VpcInfo

property vsan_encryption_config

Gets the vsan_encryption_config of this AwsSddcResourceConfig. # noqa: E501

Returns

The vsan_encryption_config of this AwsSddcResourceConfig. # noqa: E501

Return type

VsanEncryptionConfig

vmware.vmc.console.models.aws_sddc_resource_config_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_sddc_resource_config_all_of.AwsSddcResourceConfigAllOf(backup_restore_bucket=None, public_ip_pool=None, vpc_info=None, kms_vpc_endpoint=None, max_num_public_ip=None, account_link_sddc_config=None, vsan_encryption_config=None, vpc_info_peered_agent=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsSddcResourceConfigAllOf - a model defined in OpenAPI

Gets the account_link_sddc_config of this AwsSddcResourceConfigAllOf. # noqa: E501

Returns

The account_link_sddc_config of this AwsSddcResourceConfigAllOf. # noqa: E501

Return type

list[SddcLinkConfig]

attribute_map = {'account_link_sddc_config': 'account_link_sddc_config', 'backup_restore_bucket': 'backup_restore_bucket', 'kms_vpc_endpoint': 'kms_vpc_endpoint', 'max_num_public_ip': 'max_num_public_ip', 'public_ip_pool': 'public_ip_pool', 'vpc_info': 'vpc_info', 'vpc_info_peered_agent': 'vpc_info_peered_agent', 'vsan_encryption_config': 'vsan_encryption_config'}
property backup_restore_bucket

Gets the backup_restore_bucket of this AwsSddcResourceConfigAllOf. # noqa: E501

Returns

The backup_restore_bucket of this AwsSddcResourceConfigAllOf. # noqa: E501

Return type

str

property kms_vpc_endpoint

Gets the kms_vpc_endpoint of this AwsSddcResourceConfigAllOf. # noqa: E501

Returns

The kms_vpc_endpoint of this AwsSddcResourceConfigAllOf. # noqa: E501

Return type

KmsVpcEndpoint

property max_num_public_ip

Gets the max_num_public_ip of this AwsSddcResourceConfigAllOf. # noqa: E501

maximum number of public IP that user can allocate. # noqa: E501

Returns

The max_num_public_ip of this AwsSddcResourceConfigAllOf. # noqa: E501

Return type

int

openapi_types = {'account_link_sddc_config': 'list[SddcLinkConfig]', 'backup_restore_bucket': 'str', 'kms_vpc_endpoint': 'KmsVpcEndpoint', 'max_num_public_ip': 'int', 'public_ip_pool': 'list[SddcPublicIp]', 'vpc_info': 'VpcInfo', 'vpc_info_peered_agent': 'VpcInfo', 'vsan_encryption_config': 'VsanEncryptionConfig'}
property public_ip_pool

Gets the public_ip_pool of this AwsSddcResourceConfigAllOf. # noqa: E501

Returns

The public_ip_pool of this AwsSddcResourceConfigAllOf. # noqa: E501

Return type

list[SddcPublicIp]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpc_info

Gets the vpc_info of this AwsSddcResourceConfigAllOf. # noqa: E501

Returns

The vpc_info of this AwsSddcResourceConfigAllOf. # noqa: E501

Return type

VpcInfo

property vpc_info_peered_agent

Gets the vpc_info_peered_agent of this AwsSddcResourceConfigAllOf. # noqa: E501

Returns

The vpc_info_peered_agent of this AwsSddcResourceConfigAllOf. # noqa: E501

Return type

VpcInfo

property vsan_encryption_config

Gets the vsan_encryption_config of this AwsSddcResourceConfigAllOf. # noqa: E501

Returns

The vsan_encryption_config of this AwsSddcResourceConfigAllOf. # noqa: E501

Return type

VsanEncryptionConfig

vmware.vmc.console.models.aws_subnet module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.aws_subnet.AwsSubnet(connected_account_id=None, region_name=None, availability_zone=None, subnet_id=None, subnet_cidr_block=None, is_compatible=None, vpc_id=None, vpc_cidr_block=None, name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

AwsSubnet - a model defined in OpenAPI

attribute_map = {'availability_zone': 'availability_zone', 'connected_account_id': 'connected_account_id', 'is_compatible': 'is_compatible', 'name': 'name', 'region_name': 'region_name', 'subnet_cidr_block': 'subnet_cidr_block', 'subnet_id': 'subnet_id', 'vpc_cidr_block': 'vpc_cidr_block', 'vpc_id': 'vpc_id'}
property availability_zone

Gets the availability_zone of this AwsSubnet. # noqa: E501

The availability zone this subnet is in, which should be the region name plus one extra letter (ex. us-west-2a). # noqa: E501

Returns

The availability_zone of this AwsSubnet. # noqa: E501

Return type

str

property connected_account_id

Gets the connected_account_id of this AwsSubnet. # noqa: E501

The connected account ID this subnet is accessible through. This is an internal ID formatted as a UUID specific to Skyscraper. # noqa: E501

Returns

The connected_account_id of this AwsSubnet. # noqa: E501

Return type

str

property is_compatible

Gets the is_compatible of this AwsSubnet. # noqa: E501

Flag indicating whether this subnet is compatible. If true, this is a valid choice for the customer to deploy a SDDC in. # noqa: E501

Returns

The is_compatible of this AwsSubnet. # noqa: E501

Return type

bool

property name

Gets the name of this AwsSubnet. # noqa: E501

Optional field (may not be provided by AWS), indicates the found name tag for the subnet. # noqa: E501

Returns

The name of this AwsSubnet. # noqa: E501

Return type

str

openapi_types = {'availability_zone': 'str', 'connected_account_id': 'str', 'is_compatible': 'bool', 'name': 'str', 'region_name': 'str', 'subnet_cidr_block': 'str', 'subnet_id': 'str', 'vpc_cidr_block': 'str', 'vpc_id': 'str'}
property region_name

Gets the region_name of this AwsSubnet. # noqa: E501

The region this subnet is in, usually in the form of country code, general location, and a number (ex. us-west-2). # noqa: E501

Returns

The region_name of this AwsSubnet. # noqa: E501

Return type

str

property subnet_cidr_block

Gets the subnet_cidr_block of this AwsSubnet. # noqa: E501

The CIDR block of the subnet, in the form of ‘#.#.#.#/#’. # noqa: E501

Returns

The subnet_cidr_block of this AwsSubnet. # noqa: E501

Return type

str

property subnet_id

Gets the subnet_id of this AwsSubnet. # noqa: E501

The subnet ID in AWS, provided in the form ‘subnet-######’. # noqa: E501

Returns

The subnet_id of this AwsSubnet. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpc_cidr_block

Gets the vpc_cidr_block of this AwsSubnet. # noqa: E501

The CIDR block of the VPC, in the form of ‘#.#.#.#/#’. # noqa: E501

Returns

The vpc_cidr_block of this AwsSubnet. # noqa: E501

Return type

str

property vpc_id

Gets the vpc_id of this AwsSubnet. # noqa: E501

The VPC ID the subnet resides in within AWS. Tends to be ‘vpc-#######’. # noqa: E501

Returns

The vpc_id of this AwsSubnet. # noqa: E501

Return type

str

vmware.vmc.console.models.ca_certificates module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ca_certificates.CaCertificates(ca_certificate=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

CaCertificates - a model defined in OpenAPI

attribute_map = {'ca_certificate': 'caCertificate'}
property ca_certificate

Gets the ca_certificate of this CaCertificates. # noqa: E501

Returns

The ca_certificate of this CaCertificates. # noqa: E501

Return type

list[str]

openapi_types = {'ca_certificate': 'list[str]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.cbm_statistic module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.cbm_statistic.CbmStatistic(vnic=None, timestamp=None, out=None, _in=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

CbmStatistic - a model defined in OpenAPI

attribute_map = {'_in': 'in', 'out': 'out', 'timestamp': 'timestamp', 'vnic': 'vnic'}
openapi_types = {'_in': 'float', 'out': 'float', 'timestamp': 'int', 'vnic': 'int'}
property out

Gets the out of this CbmStatistic. # noqa: E501

Tx rate (Kilobits per second - kbps) # noqa: E501

Returns

The out of this CbmStatistic. # noqa: E501

Return type

float

property timestamp

Gets the timestamp of this CbmStatistic. # noqa: E501

Timestamp value. # noqa: E501

Returns

The timestamp of this CbmStatistic. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vnic

Gets the vnic of this CbmStatistic. # noqa: E501

Vnic index. # noqa: E501

Returns

The vnic of this CbmStatistic. # noqa: E501

Return type

int

vmware.vmc.console.models.cbm_statistics module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.cbm_statistics.CbmStatistics(data_dto=None, meta_dto=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

CbmStatistics - a model defined in OpenAPI

attribute_map = {'data_dto': 'dataDto', 'meta_dto': 'metaDto'}
property data_dto

Gets the data_dto of this CbmStatistics. # noqa: E501

Returns

The data_dto of this CbmStatistics. # noqa: E501

Return type

CbmStatsData

property meta_dto

Gets the meta_dto of this CbmStatistics. # noqa: E501

Returns

The meta_dto of this CbmStatistics. # noqa: E501

Return type

MetaDashboardStats

openapi_types = {'data_dto': 'CbmStatsData', 'meta_dto': 'MetaDashboardStats'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.cbm_stats_data module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.cbm_stats_data.CbmStatsData(vnic_9=None, vnic_8=None, vnic_7=None, vnic_6=None, vnic_5=None, vnic_4=None, vnic_3=None, vnic_2=None, vnic_1=None, vnic_0=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

CbmStatsData - a model defined in OpenAPI

attribute_map = {'vnic_0': 'vnic_0', 'vnic_1': 'vnic_1', 'vnic_2': 'vnic_2', 'vnic_3': 'vnic_3', 'vnic_4': 'vnic_4', 'vnic_5': 'vnic_5', 'vnic_6': 'vnic_6', 'vnic_7': 'vnic_7', 'vnic_8': 'vnic_8', 'vnic_9': 'vnic_9'}
openapi_types = {'vnic_0': 'list[CbmStatistic]', 'vnic_1': 'list[CbmStatistic]', 'vnic_2': 'list[CbmStatistic]', 'vnic_3': 'list[CbmStatistic]', 'vnic_4': 'list[CbmStatistic]', 'vnic_5': 'list[CbmStatistic]', 'vnic_6': 'list[CbmStatistic]', 'vnic_7': 'list[CbmStatistic]', 'vnic_8': 'list[CbmStatistic]', 'vnic_9': 'list[CbmStatistic]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vnic_0

Gets the vnic_0 of this CbmStatsData. # noqa: E501

Returns

The vnic_0 of this CbmStatsData. # noqa: E501

Return type

list[CbmStatistic]

property vnic_1

Gets the vnic_1 of this CbmStatsData. # noqa: E501

Returns

The vnic_1 of this CbmStatsData. # noqa: E501

Return type

list[CbmStatistic]

property vnic_2

Gets the vnic_2 of this CbmStatsData. # noqa: E501

Returns

The vnic_2 of this CbmStatsData. # noqa: E501

Return type

list[CbmStatistic]

property vnic_3

Gets the vnic_3 of this CbmStatsData. # noqa: E501

Returns

The vnic_3 of this CbmStatsData. # noqa: E501

Return type

list[CbmStatistic]

property vnic_4

Gets the vnic_4 of this CbmStatsData. # noqa: E501

Returns

The vnic_4 of this CbmStatsData. # noqa: E501

Return type

list[CbmStatistic]

property vnic_5

Gets the vnic_5 of this CbmStatsData. # noqa: E501

Returns

The vnic_5 of this CbmStatsData. # noqa: E501

Return type

list[CbmStatistic]

property vnic_6

Gets the vnic_6 of this CbmStatsData. # noqa: E501

Returns

The vnic_6 of this CbmStatsData. # noqa: E501

Return type

list[CbmStatistic]

property vnic_7

Gets the vnic_7 of this CbmStatsData. # noqa: E501

Returns

The vnic_7 of this CbmStatsData. # noqa: E501

Return type

list[CbmStatistic]

property vnic_8

Gets the vnic_8 of this CbmStatsData. # noqa: E501

Returns

The vnic_8 of this CbmStatsData. # noqa: E501

Return type

list[CbmStatistic]

property vnic_9

Gets the vnic_9 of this CbmStatsData. # noqa: E501

Returns

The vnic_9 of this CbmStatsData. # noqa: E501

Return type

list[CbmStatistic]

vmware.vmc.console.models.cloud_provider module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.cloud_provider.CloudProvider(provider=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

CloudProvider - a model defined in OpenAPI

attribute_map = {'provider': 'provider'}
discriminator_value_class_map = {'AwsCloudProvider': 'AwsCloudProvider'}
get_real_child_model(data)

Returns the real base class specified by the discriminator

openapi_types = {'provider': 'str'}
property provider

Gets the provider of this CloudProvider. # noqa: E501

Name of the Cloud Provider # noqa: E501

Returns

The provider of this CloudProvider. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.cluster module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.cluster.Cluster(esx_host_list=None, msft_license_config=None, cluster_state=None, aws_kms_info=None, cluster_capacity=None, esx_host_info=None, host_cpu_cores_count=None, cluster_id=None, cluster_name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Cluster - a model defined in OpenAPI

attribute_map = {'aws_kms_info': 'aws_kms_info', 'cluster_capacity': 'cluster_capacity', 'cluster_id': 'cluster_id', 'cluster_name': 'cluster_name', 'cluster_state': 'cluster_state', 'esx_host_info': 'esx_host_info', 'esx_host_list': 'esx_host_list', 'host_cpu_cores_count': 'host_cpu_cores_count', 'msft_license_config': 'msft_license_config'}
property aws_kms_info

Gets the aws_kms_info of this Cluster. # noqa: E501

Returns

The aws_kms_info of this Cluster. # noqa: E501

Return type

AwsKmsInfo

property cluster_capacity

Gets the cluster_capacity of this Cluster. # noqa: E501

Returns

The cluster_capacity of this Cluster. # noqa: E501

Return type

EntityCapacity

property cluster_id

Gets the cluster_id of this Cluster. # noqa: E501

Returns

The cluster_id of this Cluster. # noqa: E501

Return type

str

property cluster_name

Gets the cluster_name of this Cluster. # noqa: E501

Returns

The cluster_name of this Cluster. # noqa: E501

Return type

str

property cluster_state

Gets the cluster_state of this Cluster. # noqa: E501

Returns

The cluster_state of this Cluster. # noqa: E501

Return type

str

property esx_host_info

Gets the esx_host_info of this Cluster. # noqa: E501

Returns

The esx_host_info of this Cluster. # noqa: E501

Return type

EsxHostInfo

property esx_host_list

Gets the esx_host_list of this Cluster. # noqa: E501

Returns

The esx_host_list of this Cluster. # noqa: E501

Return type

list[AwsEsxHost]

property host_cpu_cores_count

Gets the host_cpu_cores_count of this Cluster. # noqa: E501

Number of cores enabled on ESX hosts added to this cluster # noqa: E501

Returns

The host_cpu_cores_count of this Cluster. # noqa: E501

Return type

int

property msft_license_config

Gets the msft_license_config of this Cluster. # noqa: E501

Returns

The msft_license_config of this Cluster. # noqa: E501

Return type

MsftLicensingConfig

openapi_types = {'aws_kms_info': 'AwsKmsInfo', 'cluster_capacity': 'EntityCapacity', 'cluster_id': 'str', 'cluster_name': 'str', 'cluster_state': 'str', 'esx_host_info': 'EsxHostInfo', 'esx_host_list': 'list[AwsEsxHost]', 'host_cpu_cores_count': 'int', 'msft_license_config': 'MsftLicensingConfig'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.cluster_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.cluster_config.ClusterConfig(host_cpu_cores_count=None, host_instance_type=None, storage_capacity=None, msft_license_config=None, num_hosts=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ClusterConfig - a model defined in OpenAPI

attribute_map = {'host_cpu_cores_count': 'host_cpu_cores_count', 'host_instance_type': 'host_instance_type', 'msft_license_config': 'msft_license_config', 'num_hosts': 'num_hosts', 'storage_capacity': 'storage_capacity'}
property host_cpu_cores_count

Gets the host_cpu_cores_count of this ClusterConfig. # noqa: E501

Customize CPU cores on hosts in a cluster. Specify number of cores to be enabled on hosts in a cluster. # noqa: E501

Returns

The host_cpu_cores_count of this ClusterConfig. # noqa: E501

Return type

int

property host_instance_type

Gets the host_instance_type of this ClusterConfig. # noqa: E501

Returns

The host_instance_type of this ClusterConfig. # noqa: E501

Return type

HostInstanceTypes

property msft_license_config

Gets the msft_license_config of this ClusterConfig. # noqa: E501

Returns

The msft_license_config of this ClusterConfig. # noqa: E501

Return type

MsftLicensingConfig

property num_hosts

Gets the num_hosts of this ClusterConfig. # noqa: E501

Returns

The num_hosts of this ClusterConfig. # noqa: E501

Return type

int

openapi_types = {'host_cpu_cores_count': 'int', 'host_instance_type': 'HostInstanceTypes', 'msft_license_config': 'MsftLicensingConfig', 'num_hosts': 'int', 'storage_capacity': 'int'}
property storage_capacity

Gets the storage_capacity of this ClusterConfig. # noqa: E501

For EBS-backed instances only, the requested storage capacity in GiB. # noqa: E501

Returns

The storage_capacity of this ClusterConfig. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.cluster_reconfigure_params module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.cluster_reconfigure_params.ClusterReconfigureParams(storage_capacity=None, bias=None, num_hosts=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ClusterReconfigureParams - a model defined in OpenAPI

attribute_map = {'bias': 'bias', 'num_hosts': 'num_hosts', 'storage_capacity': 'storage_capacity'}
property bias

Gets the bias of this ClusterReconfigureParams. # noqa: E501

Bias value as obtained from the storage constraints call. # noqa: E501

Returns

The bias of this ClusterReconfigureParams. # noqa: E501

Return type

str

property num_hosts

Gets the num_hosts of this ClusterReconfigureParams. # noqa: E501

Number of hosts in the cluster after reconfiguring. # noqa: E501

Returns

The num_hosts of this ClusterReconfigureParams. # noqa: E501

Return type

int

openapi_types = {'bias': 'str', 'num_hosts': 'int', 'storage_capacity': 'int'}
property storage_capacity

Gets the storage_capacity of this ClusterReconfigureParams. # noqa: E501

The final desired storage capacity after reconfiguring the cluster in GiB. # noqa: E501

Returns

The storage_capacity of this ClusterReconfigureParams. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.compute_gateway_template module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.compute_gateway_template.ComputeGatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, logical_networks=None, nat_rules=None, l2_vpn=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ComputeGatewayTemplate - a model defined in OpenAPI

attribute_map = {'firewall_rules': 'firewall_rules', 'l2_vpn': 'l2_vpn', 'logical_networks': 'logical_networks', 'nat_rules': 'nat_rules', 'primary_dns': 'primary_dns', 'public_ip': 'public_ip', 'secondary_dns': 'secondary_dns', 'vpns': 'vpns'}
property firewall_rules

Gets the firewall_rules of this ComputeGatewayTemplate. # noqa: E501

Returns

The firewall_rules of this ComputeGatewayTemplate. # noqa: E501

Return type

list[FirewallRule]

property l2_vpn

Gets the l2_vpn of this ComputeGatewayTemplate. # noqa: E501

Returns

The l2_vpn of this ComputeGatewayTemplate. # noqa: E501

Return type

object

property logical_networks

Gets the logical_networks of this ComputeGatewayTemplate. # noqa: E501

Returns

The logical_networks of this ComputeGatewayTemplate. # noqa: E501

Return type

list[LogicalNetwork]

property nat_rules

Gets the nat_rules of this ComputeGatewayTemplate. # noqa: E501

Returns

The nat_rules of this ComputeGatewayTemplate. # noqa: E501

Return type

list[NatRule]

openapi_types = {'firewall_rules': 'list[FirewallRule]', 'l2_vpn': 'object', 'logical_networks': 'list[LogicalNetwork]', 'nat_rules': 'list[NatRule]', 'primary_dns': 'str', 'public_ip': 'SddcPublicIp', 'secondary_dns': 'str', 'vpns': 'list[Vpn]'}
property primary_dns

Gets the primary_dns of this ComputeGatewayTemplate. # noqa: E501

Returns

The primary_dns of this ComputeGatewayTemplate. # noqa: E501

Return type

str

property public_ip

Gets the public_ip of this ComputeGatewayTemplate. # noqa: E501

Returns

The public_ip of this ComputeGatewayTemplate. # noqa: E501

Return type

SddcPublicIp

property secondary_dns

Gets the secondary_dns of this ComputeGatewayTemplate. # noqa: E501

Returns

The secondary_dns of this ComputeGatewayTemplate. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpns

Gets the vpns of this ComputeGatewayTemplate. # noqa: E501

Returns

The vpns of this ComputeGatewayTemplate. # noqa: E501

Return type

list[Vpn]

vmware.vmc.console.models.compute_gateway_template_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.compute_gateway_template_all_of.ComputeGatewayTemplateAllOf(logical_networks=None, nat_rules=None, l2_vpn=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ComputeGatewayTemplateAllOf - a model defined in OpenAPI

attribute_map = {'l2_vpn': 'l2_vpn', 'logical_networks': 'logical_networks', 'nat_rules': 'nat_rules'}
property l2_vpn

Gets the l2_vpn of this ComputeGatewayTemplateAllOf. # noqa: E501

Returns

The l2_vpn of this ComputeGatewayTemplateAllOf. # noqa: E501

Return type

object

property logical_networks

Gets the logical_networks of this ComputeGatewayTemplateAllOf. # noqa: E501

Returns

The logical_networks of this ComputeGatewayTemplateAllOf. # noqa: E501

Return type

list[LogicalNetwork]

property nat_rules

Gets the nat_rules of this ComputeGatewayTemplateAllOf. # noqa: E501

Returns

The nat_rules of this ComputeGatewayTemplateAllOf. # noqa: E501

Return type

list[NatRule]

openapi_types = {'l2_vpn': 'object', 'logical_networks': 'list[LogicalNetwork]', 'nat_rules': 'list[NatRule]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.config_spec module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.config_spec.ConfigSpec(expiry_in_days=None, availability=None, sddc_sizes=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ConfigSpec - a model defined in OpenAPI

attribute_map = {'availability': 'availability', 'expiry_in_days': 'expiry_in_days', 'sddc_sizes': 'sddc_sizes'}
property availability

Gets the availability of this ConfigSpec. # noqa: E501

Map of region to instance types available in that region # noqa: E501

Returns

The availability of this ConfigSpec. # noqa: E501

Return type

dict(str, list[InstanceTypeConfig])

property expiry_in_days

Gets the expiry_in_days of this ConfigSpec. # noqa: E501

Indicates after how many days the sddc should expire # noqa: E501

Returns

The expiry_in_days of this ConfigSpec. # noqa: E501

Return type

int

openapi_types = {'availability': 'dict(str, list[InstanceTypeConfig])', 'expiry_in_days': 'int', 'sddc_sizes': 'list[str]'}
property sddc_sizes

Gets the sddc_sizes of this ConfigSpec. # noqa: E501

Returns

The sddc_sizes of this ConfigSpec. # noqa: E501

Return type

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.connectivity_agent_validation module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.connectivity_agent_validation.ConnectivityAgentValidation(source=None, type=None, ports=None, path=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ConnectivityAgentValidation - a model defined in OpenAPI

attribute_map = {'path': 'path', 'ports': 'ports', 'source': 'source', 'type': 'type'}
openapi_types = {'path': 'str', 'ports': 'list[str]', 'source': 'str', 'type': 'str'}
property path

Gets the path of this ConnectivityAgentValidation. # noqa: E501

URL path ONLY for CURL tests. # noqa: E501

Returns

The path of this ConnectivityAgentValidation. # noqa: E501

Return type

str

property ports

Gets the ports of this ConnectivityAgentValidation. # noqa: E501

TCP ports ONLY for CONNECTIVITY and CURL tests. # noqa: E501

Returns

The ports of this ConnectivityAgentValidation. # noqa: E501

Return type

list[str]

property source

Gets the source of this ConnectivityAgentValidation. # noqa: E501

source appliance of connectivity test, i.e. VCENTER, SRM, VR. # noqa: E501

Returns

The source of this ConnectivityAgentValidation. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this ConnectivityAgentValidation. # noqa: E501

type of connectivity test, i.e. PING, TRACEROUTE, DNS, CONNECTIVITY, CURL. For CONNECTIVITY and CURL tests only, please specify the ports to be tested against. # noqa: E501

Returns

The type of this ConnectivityAgentValidation. # noqa: E501

Return type

str

vmware.vmc.console.models.connectivity_validation_group module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.connectivity_validation_group.ConnectivityValidationGroup(id=None, name=None, sub_groups=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ConnectivityValidationGroup - a model defined in OpenAPI

attribute_map = {'id': 'id', 'name': 'name', 'sub_groups': 'sub_groups'}
property id

Gets the id of this ConnectivityValidationGroup. # noqa: E501

test group id, currently, only HLM. # noqa: E501

Returns

The id of this ConnectivityValidationGroup. # noqa: E501

Return type

str

property name

Gets the name of this ConnectivityValidationGroup. # noqa: E501

Name of the test group. # noqa: E501

Returns

The name of this ConnectivityValidationGroup. # noqa: E501

Return type

str

openapi_types = {'id': 'str', 'name': 'str', 'sub_groups': 'list[ConnectivityValidationSubGroup]'}
property sub_groups

Gets the sub_groups of this ConnectivityValidationGroup. # noqa: E501

List of sub groups. # noqa: E501

Returns

The sub_groups of this ConnectivityValidationGroup. # noqa: E501

Return type

list[ConnectivityValidationSubGroup]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.connectivity_validation_groups module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.connectivity_validation_groups.ConnectivityValidationGroups(groups=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ConnectivityValidationGroups - a model defined in OpenAPI

attribute_map = {'groups': 'groups'}
property groups

Gets the groups of this ConnectivityValidationGroups. # noqa: E501

List of groups. # noqa: E501

Returns

The groups of this ConnectivityValidationGroups. # noqa: E501

Return type

list[ConnectivityValidationGroup]

openapi_types = {'groups': 'list[ConnectivityValidationGroup]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.connectivity_validation_input module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.connectivity_validation_input.ConnectivityValidationInput(id=None, value=None, label=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ConnectivityValidationInput - a model defined in OpenAPI

attribute_map = {'id': 'id', 'label': 'label', 'value': 'value'}
property id

Gets the id of this ConnectivityValidationInput. # noqa: E501

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. # noqa: E501

Returns

The id of this ConnectivityValidationInput. # noqa: E501

Return type

str

property label

Gets the label of this ConnectivityValidationInput. # noqa: E501

(Optional, for UI display only) input value label. # noqa: E501

Returns

The label of this ConnectivityValidationInput. # noqa: E501

Return type

str

openapi_types = {'id': 'str', 'label': 'str', 'value': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this ConnectivityValidationInput. # noqa: E501

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. # noqa: E501

Returns

The value of this ConnectivityValidationInput. # noqa: E501

Return type

str

vmware.vmc.console.models.connectivity_validation_sub_group module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.connectivity_validation_sub_group.ConnectivityValidationSubGroup(inputs=None, tests=None, label=None, help=None, id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ConnectivityValidationSubGroup - a model defined in OpenAPI

attribute_map = {'help': 'help', 'id': 'id', 'inputs': 'inputs', 'label': 'label', 'tests': 'tests'}
property help

Gets the help of this ConnectivityValidationSubGroup. # noqa: E501

Help text. # noqa: E501

Returns

The help of this ConnectivityValidationSubGroup. # noqa: E501

Return type

str

property id

Gets the id of this ConnectivityValidationSubGroup. # noqa: E501

subGroup id, i.e. PRIMARY_DNS, SECONDARY_DNS, ONPREM_VCENTER, ONPREM_PSC, ACTIVE_DIRECTORY, ONPREM_ESX, DRAAS_ONPREM_VCENTER, DRAAS_ONPREM_PSC, DRAAS_ONPREM_SRM and DRAAS_ONPREM_VR. # noqa: E501

Returns

The id of this ConnectivityValidationSubGroup. # noqa: E501

Return type

str

property inputs

Gets the inputs of this ConnectivityValidationSubGroup. # noqa: E501

List of user inputs for the sub group. # noqa: E501

Returns

The inputs of this ConnectivityValidationSubGroup. # noqa: E501

Return type

list[ConnectivityValidationInput]

property label

Gets the label of this ConnectivityValidationSubGroup. # noqa: E501

Name of the sub-group. # noqa: E501

Returns

The label of this ConnectivityValidationSubGroup. # noqa: E501

Return type

str

openapi_types = {'help': 'str', 'id': 'str', 'inputs': 'list[ConnectivityValidationInput]', 'label': 'str', 'tests': 'list[ConnectivityAgentValidation]'}
property tests

Gets the tests of this ConnectivityValidationSubGroup. # noqa: E501

List of connectivity tests. # noqa: E501

Returns

The tests of this ConnectivityValidationSubGroup. # noqa: E501

Return type

list[ConnectivityAgentValidation]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.crl_certificates module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.crl_certificates.CrlCertificates(crl_certificate=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

CrlCertificates - a model defined in OpenAPI

attribute_map = {'crl_certificate': 'crlCertificate'}
property crl_certificate

Gets the crl_certificate of this CrlCertificates. # noqa: E501

Returns

The crl_certificate of this CrlCertificates. # noqa: E501

Return type

list[str]

openapi_types = {'crl_certificate': 'list[str]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.customer_eni_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.customer_eni_info.CustomerEniInfo(secondary_ip_addresses=None, eni_id=None, primary_ip_address=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

CustomerEniInfo - a model defined in OpenAPI

attribute_map = {'eni_id': 'eni_id', 'primary_ip_address': 'primary_ip_address', 'secondary_ip_addresses': 'secondary_ip_addresses'}
property eni_id

Gets the eni_id of this CustomerEniInfo. # noqa: E501

Interface ID on customer account. # noqa: E501

Returns

The eni_id of this CustomerEniInfo. # noqa: E501

Return type

str

openapi_types = {'eni_id': 'str', 'primary_ip_address': 'str', 'secondary_ip_addresses': 'list[str]'}
property primary_ip_address

Gets the primary_ip_address of this CustomerEniInfo. # noqa: E501

Indicates primary address of the ENI. # noqa: E501

Returns

The primary_ip_address of this CustomerEniInfo. # noqa: E501

Return type

str

property secondary_ip_addresses

Gets the secondary_ip_addresses of this CustomerEniInfo. # noqa: E501

Indicates list of secondary IP created for this ENI. # noqa: E501

Returns

The secondary_ip_addresses of this CustomerEniInfo. # noqa: E501

Return type

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.dashboard_data module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dashboard_data.DashboardData(firewall=None, sslvpn=None, interfaces=None, load_balancer=None, ipsec=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DashboardData - a model defined in OpenAPI

attribute_map = {'firewall': 'firewall', 'interfaces': 'interfaces', 'ipsec': 'ipsec', 'load_balancer': 'loadBalancer', 'sslvpn': 'sslvpn'}
property firewall

Gets the firewall of this DashboardData. # noqa: E501

Returns

The firewall of this DashboardData. # noqa: E501

Return type

FirewallDashboardStats

property interfaces

Gets the interfaces of this DashboardData. # noqa: E501

Returns

The interfaces of this DashboardData. # noqa: E501

Return type

InterfacesDashboardStats

property ipsec

Gets the ipsec of this DashboardData. # noqa: E501

Returns

The ipsec of this DashboardData. # noqa: E501

Return type

IpsecDashboardStats

property load_balancer

Gets the load_balancer of this DashboardData. # noqa: E501

Returns

The load_balancer of this DashboardData. # noqa: E501

Return type

LoadBalancerDashboardStats

openapi_types = {'firewall': 'FirewallDashboardStats', 'interfaces': 'InterfacesDashboardStats', 'ipsec': 'IpsecDashboardStats', 'load_balancer': 'LoadBalancerDashboardStats', 'sslvpn': 'SslvpnDashboardStats'}
property sslvpn

Gets the sslvpn of this DashboardData. # noqa: E501

Returns

The sslvpn of this DashboardData. # noqa: E501

Return type

SslvpnDashboardStats

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.dashboard_stat module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dashboard_stat.DashboardStat(timestamp=None, value=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DashboardStat - a model defined in OpenAPI

attribute_map = {'timestamp': 'timestamp', 'value': 'value'}
openapi_types = {'timestamp': 'int', 'value': 'float'}
property timestamp

Gets the timestamp of this DashboardStat. # noqa: E501

Returns

The timestamp of this DashboardStat. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this DashboardStat. # noqa: E501

Returns

The value of this DashboardStat. # noqa: E501

Return type

float

vmware.vmc.console.models.dashboard_statistics module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dashboard_statistics.DashboardStatistics(data_dto=None, meta_dto=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DashboardStatistics - a model defined in OpenAPI

attribute_map = {'data_dto': 'dataDto', 'meta_dto': 'metaDto'}
property data_dto

Gets the data_dto of this DashboardStatistics. # noqa: E501

Returns

The data_dto of this DashboardStatistics. # noqa: E501

Return type

DashboardData

property meta_dto

Gets the meta_dto of this DashboardStatistics. # noqa: E501

Returns

The meta_dto of this DashboardStatistics. # noqa: E501

Return type

MetaDashboardStats

openapi_types = {'data_dto': 'DashboardData', 'meta_dto': 'MetaDashboardStats'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.data_page_edge_summary module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.data_page_edge_summary.DataPageEdgeSummary(paging_info=None, data=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DataPageEdgeSummary - a model defined in OpenAPI

attribute_map = {'data': 'data', 'paging_info': 'pagingInfo'}
property data

Gets the data of this DataPageEdgeSummary. # noqa: E501

Returns

The data of this DataPageEdgeSummary. # noqa: E501

Return type

list[EdgeSummary]

openapi_types = {'data': 'list[EdgeSummary]', 'paging_info': 'PagingInfo'}
property paging_info

Gets the paging_info of this DataPageEdgeSummary. # noqa: E501

Returns

The paging_info of this DataPageEdgeSummary. # noqa: E501

Return type

PagingInfo

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.data_page_sddc_network module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.data_page_sddc_network.DataPageSddcNetwork(paging_info=None, data=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DataPageSddcNetwork - a model defined in OpenAPI

attribute_map = {'data': 'data', 'paging_info': 'pagingInfo'}
property data

Gets the data of this DataPageSddcNetwork. # noqa: E501

Returns

The data of this DataPageSddcNetwork. # noqa: E501

Return type

list[SddcNetwork]

openapi_types = {'data': 'list[SddcNetwork]', 'paging_info': 'PagingInfo'}
property paging_info

Gets the paging_info of this DataPageSddcNetwork. # noqa: E501

Returns

The paging_info of this DataPageSddcNetwork. # noqa: E501

Return type

PagingInfo

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.data_permissions module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.data_permissions.DataPermissions(save_permission=None, publish_permission=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DataPermissions - a model defined in OpenAPI

attribute_map = {'publish_permission': 'publishPermission', 'save_permission': 'savePermission'}
openapi_types = {'publish_permission': 'bool', 'save_permission': 'bool'}
property publish_permission

Gets the publish_permission of this DataPermissions. # noqa: E501

Returns

The publish_permission of this DataPermissions. # noqa: E501

Return type

bool

property save_permission

Gets the save_permission of this DataPermissions. # noqa: E501

Returns

The save_permission of this DataPermissions. # noqa: E501

Return type

bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.dhcp_lease_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dhcp_lease_info.DhcpLeaseInfo(host_lease_info_dtos=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DhcpLeaseInfo - a model defined in OpenAPI

attribute_map = {'host_lease_info_dtos': 'hostLeaseInfoDtos'}
property host_lease_info_dtos

Gets the host_lease_info_dtos of this DhcpLeaseInfo. # noqa: E501

List of DHCP leases. # noqa: E501

Returns

The host_lease_info_dtos of this DhcpLeaseInfo. # noqa: E501

Return type

list[HostLeaseInfo]

openapi_types = {'host_lease_info_dtos': 'list[HostLeaseInfo]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.dhcp_leases module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dhcp_leases.DhcpLeases(time_stamp=None, host_lease_infos_dto=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DhcpLeases - a model defined in OpenAPI

attribute_map = {'host_lease_infos_dto': 'hostLeaseInfosDto', 'time_stamp': 'timeStamp'}
property host_lease_infos_dto

Gets the host_lease_infos_dto of this DhcpLeases. # noqa: E501

Returns

The host_lease_infos_dto of this DhcpLeases. # noqa: E501

Return type

DhcpLeaseInfo

openapi_types = {'host_lease_infos_dto': 'DhcpLeaseInfo', 'time_stamp': 'int'}
property time_stamp

Gets the time_stamp of this DhcpLeases. # noqa: E501

The timestamp of the DHCP lease. # noqa: E501

Returns

The time_stamp of this DhcpLeases. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.dns_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dns_config.DnsConfig(feature_type=None, logging=None, enabled=None, dns_views=None, listeners=None, version=None, template=None, cache_size=None, dns_servers=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DnsConfig - a model defined in OpenAPI

attribute_map = {'cache_size': 'cacheSize', 'dns_servers': 'dnsServers', 'dns_views': 'dnsViews', 'enabled': 'enabled', 'feature_type': 'featureType', 'listeners': 'listeners', 'logging': 'logging', 'template': 'template', 'version': 'version'}
property cache_size

Gets the cache_size of this DnsConfig. # noqa: E501

The cache size of the DNS service. # noqa: E501

Returns

The cache_size of this DnsConfig. # noqa: E501

Return type

int

property dns_servers

Gets the dns_servers of this DnsConfig. # noqa: E501

Returns

The dns_servers of this DnsConfig. # noqa: E501

Return type

IpAddresses

property dns_views

Gets the dns_views of this DnsConfig. # noqa: E501

Returns

The dns_views of this DnsConfig. # noqa: E501

Return type

DnsViews

property enabled

Gets the enabled of this DnsConfig. # noqa: E501

Value is true if feature is enabled. Default value is true. Optional. # noqa: E501

Returns

The enabled of this DnsConfig. # noqa: E501

Return type

bool

property feature_type

Gets the feature_type of this DnsConfig. # noqa: E501

Returns

The feature_type of this DnsConfig. # noqa: E501

Return type

str

property listeners

Gets the listeners of this DnsConfig. # noqa: E501

Returns

The listeners of this DnsConfig. # noqa: E501

Return type

DnsListeners

property logging

Gets the logging of this DnsConfig. # noqa: E501

Returns

The logging of this DnsConfig. # noqa: E501

Return type

Logging

openapi_types = {'cache_size': 'int', 'dns_servers': 'IpAddresses', 'dns_views': 'DnsViews', 'enabled': 'bool', 'feature_type': 'str', 'listeners': 'DnsListeners', 'logging': 'Logging', 'template': 'str', 'version': 'int'}
property template

Gets the template of this DnsConfig. # noqa: E501

Returns

The template of this DnsConfig. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this DnsConfig. # noqa: E501

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. # noqa: E501

Returns

The version of this DnsConfig. # noqa: E501

Return type

int

vmware.vmc.console.models.dns_forwarders module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dns_forwarders.DnsForwarders(ip_address=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DnsForwarders - a model defined in OpenAPI

attribute_map = {'ip_address': 'ipAddress'}
property ip_address

Gets the ip_address of this DnsForwarders. # noqa: E501

IP addresses of the DNS servers. # noqa: E501

Returns

The ip_address of this DnsForwarders. # noqa: E501

Return type

list[str]

openapi_types = {'ip_address': 'list[str]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.dns_listeners module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dns_listeners.DnsListeners(ip_address=None, vnic=None, type=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DnsListeners - a model defined in OpenAPI

attribute_map = {'ip_address': 'ipAddress', 'type': 'type', 'vnic': 'vnic'}
property ip_address

Gets the ip_address of this DnsListeners. # noqa: E501

List of IP addresses. # noqa: E501

Returns

The ip_address of this DnsListeners. # noqa: E501

Return type

list[str]

openapi_types = {'ip_address': 'list[str]', 'type': 'str', 'vnic': 'list[str]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this DnsListeners. # noqa: E501

Returns

The type of this DnsListeners. # noqa: E501

Return type

str

property vnic

Gets the vnic of this DnsListeners. # noqa: E501

Vnic for DNS listener. # noqa: E501

Returns

The vnic of this DnsListeners. # noqa: E501

Return type

list[str]

vmware.vmc.console.models.dns_listeners_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dns_listeners_all_of.DnsListenersAllOf(vnic=None, type=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DnsListenersAllOf - a model defined in OpenAPI

attribute_map = {'type': 'type', 'vnic': 'vnic'}
openapi_types = {'type': 'str', 'vnic': 'list[str]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this DnsListenersAllOf. # noqa: E501

Returns

The type of this DnsListenersAllOf. # noqa: E501

Return type

str

property vnic

Gets the vnic of this DnsListenersAllOf. # noqa: E501

Vnic for DNS listener. # noqa: E501

Returns

The vnic of this DnsListenersAllOf. # noqa: E501

Return type

list[str]

vmware.vmc.console.models.dns_response_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dns_response_stats.DnsResponseStats(total=None, form_err=None, nx_domain=None, success=None, server_fail=None, nxrrset=None, others=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DnsResponseStats - a model defined in OpenAPI

attribute_map = {'form_err': 'formErr', 'nx_domain': 'nxDomain', 'nxrrset': 'nxrrset', 'others': 'others', 'server_fail': 'serverFail', 'success': 'success', 'total': 'total'}
property form_err

Gets the form_err of this DnsResponseStats. # noqa: E501

Returns

The form_err of this DnsResponseStats. # noqa: E501

Return type

int

property nx_domain

Gets the nx_domain of this DnsResponseStats. # noqa: E501

Returns

The nx_domain of this DnsResponseStats. # noqa: E501

Return type

int

property nxrrset

Gets the nxrrset of this DnsResponseStats. # noqa: E501

Returns

The nxrrset of this DnsResponseStats. # noqa: E501

Return type

int

openapi_types = {'form_err': 'int', 'nx_domain': 'int', 'nxrrset': 'int', 'others': 'int', 'server_fail': 'int', 'success': 'int', 'total': 'int'}
property others

Gets the others of this DnsResponseStats. # noqa: E501

Returns

The others of this DnsResponseStats. # noqa: E501

Return type

int

property server_fail

Gets the server_fail of this DnsResponseStats. # noqa: E501

Returns

The server_fail of this DnsResponseStats. # noqa: E501

Return type

int

property success

Gets the success of this DnsResponseStats. # noqa: E501

Returns

The success of this DnsResponseStats. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property total

Gets the total of this DnsResponseStats. # noqa: E501

Returns

The total of this DnsResponseStats. # noqa: E501

Return type

int

vmware.vmc.console.models.dns_status_and_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dns_status_and_stats.DnsStatusAndStats(time_stamp=None, requests=None, responses=None, cached_dbrr_set=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DnsStatusAndStats - a model defined in OpenAPI

attribute_map = {'cached_dbrr_set': 'cachedDBRRSet', 'requests': 'requests', 'responses': 'responses', 'time_stamp': 'timeStamp'}
property cached_dbrr_set

Gets the cached_dbrr_set of this DnsStatusAndStats. # noqa: E501

Returns

The cached_dbrr_set of this DnsStatusAndStats. # noqa: E501

Return type

int

openapi_types = {'cached_dbrr_set': 'int', 'requests': 'Requests', 'responses': 'DnsResponseStats', 'time_stamp': 'int'}
property requests

Gets the requests of this DnsStatusAndStats. # noqa: E501

Returns

The requests of this DnsStatusAndStats. # noqa: E501

Return type

Requests

property responses

Gets the responses of this DnsStatusAndStats. # noqa: E501

Returns

The responses of this DnsStatusAndStats. # noqa: E501

Return type

DnsResponseStats

property time_stamp

Gets the time_stamp of this DnsStatusAndStats. # noqa: E501

Returns

The time_stamp of this DnsStatusAndStats. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.dns_view module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dns_view.DnsView(name=None, view_match=None, recursion=None, view_id=None, forwarders=None, enabled=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DnsView - a model defined in OpenAPI

attribute_map = {'enabled': 'enabled', 'forwarders': 'forwarders', 'name': 'name', 'recursion': 'recursion', 'view_id': 'viewId', 'view_match': 'viewMatch'}
property enabled

Gets the enabled of this DnsView. # noqa: E501

DNS view is enabled. # noqa: E501

Returns

The enabled of this DnsView. # noqa: E501

Return type

bool

property forwarders

Gets the forwarders of this DnsView. # noqa: E501

Returns

The forwarders of this DnsView. # noqa: E501

Return type

DnsForwarders

property name

Gets the name of this DnsView. # noqa: E501

Name of the DNS view. # noqa: E501

Returns

The name of this DnsView. # noqa: E501

Return type

str

openapi_types = {'enabled': 'bool', 'forwarders': 'DnsForwarders', 'name': 'str', 'recursion': 'bool', 'view_id': 'str', 'view_match': 'DnsViewMatch'}
property recursion

Gets the recursion of this DnsView. # noqa: E501

Recursion enabled on DNS view. # noqa: E501

Returns

The recursion of this DnsView. # noqa: E501

Return type

bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property view_id

Gets the view_id of this DnsView. # noqa: E501

Identifier for the DNS view. # noqa: E501

Returns

The view_id of this DnsView. # noqa: E501

Return type

str

property view_match

Gets the view_match of this DnsView. # noqa: E501

Returns

The view_match of this DnsView. # noqa: E501

Return type

DnsViewMatch

vmware.vmc.console.models.dns_view_match module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dns_view_match.DnsViewMatch(vnic=None, ip_set=None, ip_address=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DnsViewMatch - a model defined in OpenAPI

attribute_map = {'ip_address': 'ipAddress', 'ip_set': 'ipSet', 'vnic': 'vnic'}
property ip_address

Gets the ip_address of this DnsViewMatch. # noqa: E501

Returns

The ip_address of this DnsViewMatch. # noqa: E501

Return type

list[str]

property ip_set

Gets the ip_set of this DnsViewMatch. # noqa: E501

Returns

The ip_set of this DnsViewMatch. # noqa: E501

Return type

list[str]

openapi_types = {'ip_address': 'list[str]', 'ip_set': 'list[str]', 'vnic': 'list[str]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vnic

Gets the vnic of this DnsViewMatch. # noqa: E501

Returns

The vnic of this DnsViewMatch. # noqa: E501

Return type

list[str]

vmware.vmc.console.models.dns_views module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.dns_views.DnsViews(dns_view=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

DnsViews - a model defined in OpenAPI

attribute_map = {'dns_view': 'dnsView'}
property dns_view

Gets the dns_view of this DnsViews. # noqa: E501

List of DNS views. # noqa: E501

Returns

The dns_view of this DnsViews. # noqa: E501

Return type

list[DnsView]

openapi_types = {'dns_view': 'list[DnsView]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.ebs_backed_vsan_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ebs_backed_vsan_config.EbsBackedVsanConfig(instance_type=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EbsBackedVsanConfig - a model defined in OpenAPI

attribute_map = {'instance_type': 'instance_type'}
property instance_type

Gets the instance_type of this EbsBackedVsanConfig. # noqa: E501

instance type for EBS-backed VSAN configuration # noqa: E501

Returns

The instance_type of this EbsBackedVsanConfig. # noqa: E501

Return type

str

openapi_types = {'instance_type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.edge_job module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.edge_job.EdgeJob(status=None, edge_id=None, module=None, job_id=None, error_code=None, result=None, start_time=None, message=None, end_time=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EdgeJob - a model defined in OpenAPI

attribute_map = {'edge_id': 'edgeId', 'end_time': 'endTime', 'error_code': 'errorCode', 'job_id': 'jobId', 'message': 'message', 'module': 'module', 'result': 'result', 'start_time': 'startTime', 'status': 'status'}
property edge_id

Gets the edge_id of this EdgeJob. # noqa: E501

NSX Edge ID. # noqa: E501

Returns

The edge_id of this EdgeJob. # noqa: E501

Return type

str

property end_time

Gets the end_time of this EdgeJob. # noqa: E501

Job end time. # noqa: E501

Returns

The end_time of this EdgeJob. # noqa: E501

Return type

datetime

property error_code

Gets the error_code of this EdgeJob. # noqa: E501

Error code identifying the failure of the configuration change. # noqa: E501

Returns

The error_code of this EdgeJob. # noqa: E501

Return type

str

property job_id

Gets the job_id of this EdgeJob. # noqa: E501

Job ID. # noqa: E501

Returns

The job_id of this EdgeJob. # noqa: E501

Return type

str

property message

Gets the message of this EdgeJob. # noqa: E501

Job message. # noqa: E501

Returns

The message of this EdgeJob. # noqa: E501

Return type

str

property module

Gets the module of this EdgeJob. # noqa: E501

Module information. # noqa: E501

Returns

The module of this EdgeJob. # noqa: E501

Return type

str

openapi_types = {'edge_id': 'str', 'end_time': 'datetime', 'error_code': 'str', 'job_id': 'str', 'message': 'str', 'module': 'str', 'result': 'list[Result]', 'start_time': 'datetime', 'status': 'str'}
property result

Gets the result of this EdgeJob. # noqa: E501

Job result information. # noqa: E501

Returns

The result of this EdgeJob. # noqa: E501

Return type

list[Result]

property start_time

Gets the start_time of this EdgeJob. # noqa: E501

Job start time. # noqa: E501

Returns

The start_time of this EdgeJob. # noqa: E501

Return type

datetime

property status

Gets the status of this EdgeJob. # noqa: E501

Job status. # noqa: E501

Returns

The status of this EdgeJob. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.edge_status module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.edge_status.EdgeStatus(pre_rules_exists=None, feature_statuses=None, timestamp=None, publish_status=None, last_published_pre_rules_generation_number=None, version=None, edge_vm_status=None, active_vse_ha_index=None, system_status=None, ha_vnic_in_use=None, edge_status=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EdgeStatus - a model defined in OpenAPI

property active_vse_ha_index

Gets the active_vse_ha_index of this EdgeStatus. # noqa: E501

Index of the active NSX Edge appliance. Values are 0 and 1. # noqa: E501

Returns

The active_vse_ha_index of this EdgeStatus. # noqa: E501

Return type

int

attribute_map = {'active_vse_ha_index': 'activeVseHaIndex', 'edge_status': 'edgeStatus', 'edge_vm_status': 'edgeVmStatus', 'feature_statuses': 'featureStatuses', 'ha_vnic_in_use': 'haVnicInUse', 'last_published_pre_rules_generation_number': 'lastPublishedPreRulesGenerationNumber', 'pre_rules_exists': 'preRulesExists', 'publish_status': 'publishStatus', 'system_status': 'systemStatus', 'timestamp': 'timestamp', 'version': 'version'}
property edge_status

Gets the edge_status of this EdgeStatus. # noqa: E501

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. # noqa: E501

Returns

The edge_status of this EdgeStatus. # noqa: E501

Return type

str

property edge_vm_status

Gets the edge_vm_status of this EdgeStatus. # noqa: E501

Detailed status of each of the deployed NSX Edge appliances. # noqa: E501

Returns

The edge_vm_status of this EdgeStatus. # noqa: E501

Return type

list[EdgeVmStatus]

property feature_statuses

Gets the feature_statuses of this EdgeStatus. # noqa: E501

Individual feature status. # noqa: E501

Returns

The feature_statuses of this EdgeStatus. # noqa: E501

Return type

list[FeatureStatus]

property ha_vnic_in_use

Gets the ha_vnic_in_use of this EdgeStatus. # noqa: E501

Index of the vnic consumed for NSX Edge HA. # noqa: E501

Returns

The ha_vnic_in_use of this EdgeStatus. # noqa: E501

Return type

int

property last_published_pre_rules_generation_number

Gets the last_published_pre_rules_generation_number of this EdgeStatus. # noqa: E501

Value of the last published pre rules generation number. # noqa: E501

Returns

The last_published_pre_rules_generation_number of this EdgeStatus. # noqa: E501

Return type

int

openapi_types = {'active_vse_ha_index': 'int', 'edge_status': 'str', 'edge_vm_status': 'list[EdgeVmStatus]', 'feature_statuses': 'list[FeatureStatus]', 'ha_vnic_in_use': 'int', 'last_published_pre_rules_generation_number': 'int', 'pre_rules_exists': 'bool', 'publish_status': 'str', 'system_status': 'str', 'timestamp': 'int', 'version': 'int'}
property pre_rules_exists

Gets the pre_rules_exists of this EdgeStatus. # noqa: E501

Value is true if pre rules publish is enabled. # noqa: E501

Returns

The pre_rules_exists of this EdgeStatus. # noqa: E501

Return type

bool

property publish_status

Gets the publish_status of this EdgeStatus. # noqa: E501

Status of the latest configuration change for the NSX Edge. Values are APPLIED or PERSISTED (not published to NSX Edge Appliance yet). # noqa: E501

Returns

The publish_status of this EdgeStatus. # noqa: E501

Return type

str

property system_status

Gets the system_status of this EdgeStatus. # noqa: E501

System status of the active NSX Edge appliance. # noqa: E501

Returns

The system_status of this EdgeStatus. # noqa: E501

Return type

str

property timestamp

Gets the timestamp of this EdgeStatus. # noqa: E501

Timestamp value at which the NSX Edge healthcheck was done. # noqa: E501

Returns

The timestamp of this EdgeStatus. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this EdgeStatus. # noqa: E501

Version number of the current configuration. # noqa: E501

Returns

The version of this EdgeStatus. # noqa: E501

Return type

int

vmware.vmc.console.models.edge_summary module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.edge_summary.EdgeSummary(feature_capabilities=None, edge_type=None, logical_router_scopes=None, recent_job_info=None, hypervisor_assist=None, edge_assist_id=None, edge_status=None, edge_assist_instance_name=None, object_id=None, node_id=None, id=None, datacenter_name=None, state=None, client_handle=None, scope=None, type=None, revision=None, vsm_uuid=None, description=None, extended_attributes=None, local_egress_enabled=None, universal_revision=None, allowed_actions=None, object_type_name=None, is_upgrade_available=None, is_universal=None, name=None, lrouter_uuid=None, appliances_summary=None, api_version=None, tenant_id=None, datacenter_moid=None, number_of_connected_vnics=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EdgeSummary - a model defined in OpenAPI

property allowed_actions

Gets the allowed_actions of this EdgeSummary. # noqa: E501

Returns

The allowed_actions of this EdgeSummary. # noqa: E501

Return type

list[str]

property api_version

Gets the api_version of this EdgeSummary. # noqa: E501

REST API version applicable for the NSX Edge. # noqa: E501

Returns

The api_version of this EdgeSummary. # noqa: E501

Return type

str

property appliances_summary

Gets the appliances_summary of this EdgeSummary. # noqa: E501

Returns

The appliances_summary of this EdgeSummary. # noqa: E501

Return type

AppliancesSummary

attribute_map = {'allowed_actions': 'allowedActions', 'api_version': 'apiVersion', 'appliances_summary': 'appliancesSummary', 'client_handle': 'clientHandle', 'datacenter_moid': 'datacenterMoid', 'datacenter_name': 'datacenterName', 'description': 'description', 'edge_assist_id': 'edgeAssistId', 'edge_assist_instance_name': 'edgeAssistInstanceName', 'edge_status': 'edgeStatus', 'edge_type': 'edgeType', 'extended_attributes': 'extendedAttributes', 'feature_capabilities': 'featureCapabilities', 'hypervisor_assist': 'hypervisorAssist', 'id': 'id', 'is_universal': 'isUniversal', 'is_upgrade_available': 'isUpgradeAvailable', 'local_egress_enabled': 'localEgressEnabled', 'logical_router_scopes': 'logicalRouterScopes', 'lrouter_uuid': 'lrouterUuid', 'name': 'name', 'node_id': 'nodeId', 'number_of_connected_vnics': 'numberOfConnectedVnics', 'object_id': 'objectId', 'object_type_name': 'objectTypeName', 'recent_job_info': 'recentJobInfo', 'revision': 'revision', 'scope': 'scope', 'state': 'state', 'tenant_id': 'tenantId', 'type': 'type', 'universal_revision': 'universalRevision', 'vsm_uuid': 'vsmUuid'}
property client_handle

Gets the client_handle of this EdgeSummary. # noqa: E501

Returns

The client_handle of this EdgeSummary. # noqa: E501

Return type

str

property datacenter_moid

Gets the datacenter_moid of this EdgeSummary. # noqa: E501

vCenter MOID of the datacenter where the NSX Edge is deployed. # noqa: E501

Returns

The datacenter_moid of this EdgeSummary. # noqa: E501

Return type

str

property datacenter_name

Gets the datacenter_name of this EdgeSummary. # noqa: E501

Datacenter name where the NSX Edge is deployed. # noqa: E501

Returns

The datacenter_name of this EdgeSummary. # noqa: E501

Return type

str

property description

Gets the description of this EdgeSummary. # noqa: E501

Returns

The description of this EdgeSummary. # noqa: E501

Return type

str

property edge_assist_id

Gets the edge_assist_id of this EdgeSummary. # noqa: E501

ID generated by NSX Manager for Distributed Logical Router only. # noqa: E501

Returns

The edge_assist_id of this EdgeSummary. # noqa: E501

Return type

int

property edge_assist_instance_name

Gets the edge_assist_instance_name of this EdgeSummary. # noqa: E501

Name derived by NSX Manager only for Distributed Logical Router. # noqa: E501

Returns

The edge_assist_instance_name of this EdgeSummary. # noqa: E501

Return type

str

property edge_status

Gets the edge_status of this EdgeSummary. # noqa: E501

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. # noqa: E501

Returns

The edge_status of this EdgeSummary. # noqa: E501

Return type

str

property edge_type

Gets the edge_type of this EdgeSummary. # noqa: E501

NSX Edge type, whether ‘gatewayServices’ or ‘distributedRouter’. # noqa: E501

Returns

The edge_type of this EdgeSummary. # noqa: E501

Return type

str

property extended_attributes

Gets the extended_attributes of this EdgeSummary. # noqa: E501

Returns

The extended_attributes of this EdgeSummary. # noqa: E501

Return type

list[ExtendedAttribute]

property feature_capabilities

Gets the feature_capabilities of this EdgeSummary. # noqa: E501

Returns

The feature_capabilities of this EdgeSummary. # noqa: E501

Return type

FeatureCapabilities

property hypervisor_assist

Gets the hypervisor_assist of this EdgeSummary. # noqa: E501

Returns

The hypervisor_assist of this EdgeSummary. # noqa: E501

Return type

bool

property id

Gets the id of this EdgeSummary. # noqa: E501

NSX Edge ID. # noqa: E501

Returns

The id of this EdgeSummary. # noqa: E501

Return type

str

property is_universal

Gets the is_universal of this EdgeSummary. # noqa: E501

Returns

The is_universal of this EdgeSummary. # noqa: E501

Return type

bool

property is_upgrade_available

Gets the is_upgrade_available of this EdgeSummary. # noqa: E501

Value is true if NSX Edge upgrade is available. # noqa: E501

Returns

The is_upgrade_available of this EdgeSummary. # noqa: E501

Return type

bool

property local_egress_enabled

Gets the local_egress_enabled of this EdgeSummary. # noqa: E501

Value is true if local egress is enabled for UDLR traffic. Applicable only for Universal Distributed Logical Router. # noqa: E501

Returns

The local_egress_enabled of this EdgeSummary. # noqa: E501

Return type

bool

property logical_router_scopes

Gets the logical_router_scopes of this EdgeSummary. # noqa: E501

Returns

The logical_router_scopes of this EdgeSummary. # noqa: E501

Return type

LogicalRouterScopes

property lrouter_uuid

Gets the lrouter_uuid of this EdgeSummary. # noqa: E501

Distributed Logical Router UUID provided by the NSX Controller. # noqa: E501

Returns

The lrouter_uuid of this EdgeSummary. # noqa: E501

Return type

str

property name

Gets the name of this EdgeSummary. # noqa: E501

Returns

The name of this EdgeSummary. # noqa: E501

Return type

str

property node_id

Gets the node_id of this EdgeSummary. # noqa: E501

Returns

The node_id of this EdgeSummary. # noqa: E501

Return type

str

property number_of_connected_vnics

Gets the number_of_connected_vnics of this EdgeSummary. # noqa: E501

Number of connected vnics that are configured on the NSX Edge. # noqa: E501

Returns

The number_of_connected_vnics of this EdgeSummary. # noqa: E501

Return type

int

property object_id

Gets the object_id of this EdgeSummary. # noqa: E501

Returns

The object_id of this EdgeSummary. # noqa: E501

Return type

str

property object_type_name

Gets the object_type_name of this EdgeSummary. # noqa: E501

Returns

The object_type_name of this EdgeSummary. # noqa: E501

Return type

str

openapi_types = {'allowed_actions': 'list[str]', 'api_version': 'str', 'appliances_summary': 'AppliancesSummary', 'client_handle': 'str', 'datacenter_moid': 'str', 'datacenter_name': 'str', 'description': 'str', 'edge_assist_id': 'int', 'edge_assist_instance_name': 'str', 'edge_status': 'str', 'edge_type': 'str', 'extended_attributes': 'list[ExtendedAttribute]', 'feature_capabilities': 'FeatureCapabilities', 'hypervisor_assist': 'bool', 'id': 'str', 'is_universal': 'bool', 'is_upgrade_available': 'bool', 'local_egress_enabled': 'bool', 'logical_router_scopes': 'LogicalRouterScopes', 'lrouter_uuid': 'str', 'name': 'str', 'node_id': 'str', 'number_of_connected_vnics': 'int', 'object_id': 'str', 'object_type_name': 'str', 'recent_job_info': 'EdgeJob', 'revision': 'int', 'scope': 'ScopeInfo', 'state': 'str', 'tenant_id': 'str', 'type': 'ObjectType', 'universal_revision': 'int', 'vsm_uuid': 'str'}
property recent_job_info

Gets the recent_job_info of this EdgeSummary. # noqa: E501

Returns

The recent_job_info of this EdgeSummary. # noqa: E501

Return type

EdgeJob

property revision

Gets the revision of this EdgeSummary. # noqa: E501

Returns

The revision of this EdgeSummary. # noqa: E501

Return type

int

property scope

Gets the scope of this EdgeSummary. # noqa: E501

Returns

The scope of this EdgeSummary. # noqa: E501

Return type

ScopeInfo

property state

Gets the state of this EdgeSummary. # noqa: E501

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. # noqa: E501

Returns

The state of this EdgeSummary. # noqa: E501

Return type

str

property tenant_id

Gets the tenant_id of this EdgeSummary. # noqa: E501

Tenant ID for the NSX Edge. # noqa: E501

Returns

The tenant_id of this EdgeSummary. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this EdgeSummary. # noqa: E501

Returns

The type of this EdgeSummary. # noqa: E501

Return type

ObjectType

property universal_revision

Gets the universal_revision of this EdgeSummary. # noqa: E501

Returns

The universal_revision of this EdgeSummary. # noqa: E501

Return type

int

property vsm_uuid

Gets the vsm_uuid of this EdgeSummary. # noqa: E501

Returns

The vsm_uuid of this EdgeSummary. # noqa: E501

Return type

str

vmware.vmc.console.models.edge_vm_status module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.edge_vm_status.EdgeVmStatus(index=None, ha_state=None, name=None, id=None, edge_vm_status=None, pre_rules_generation_number=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EdgeVmStatus - a model defined in OpenAPI

attribute_map = {'edge_vm_status': 'edgeVMStatus', 'ha_state': 'haState', 'id': 'id', 'index': 'index', 'name': 'name', 'pre_rules_generation_number': 'preRulesGenerationNumber'}
property edge_vm_status

Gets the edge_vm_status of this EdgeVmStatus. # noqa: E501

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). # noqa: E501

Returns

The edge_vm_status of this EdgeVmStatus. # noqa: E501

Return type

str

property ha_state

Gets the ha_state of this EdgeVmStatus. # noqa: E501

High Availability state of the appliance. Values are active and standby. # noqa: E501

Returns

The ha_state of this EdgeVmStatus. # noqa: E501

Return type

str

property id

Gets the id of this EdgeVmStatus. # noqa: E501

vCenter MOID of the NSX Edge appliance. # noqa: E501

Returns

The id of this EdgeVmStatus. # noqa: E501

Return type

str

property index

Gets the index of this EdgeVmStatus. # noqa: E501

High Availability index of the appliance. Values are 0 and 1. # noqa: E501

Returns

The index of this EdgeVmStatus. # noqa: E501

Return type

int

property name

Gets the name of this EdgeVmStatus. # noqa: E501

Name of the NSX Edge appliance. # noqa: E501

Returns

The name of this EdgeVmStatus. # noqa: E501

Return type

str

openapi_types = {'edge_vm_status': 'str', 'ha_state': 'str', 'id': 'str', 'index': 'int', 'name': 'str', 'pre_rules_generation_number': 'int'}
property pre_rules_generation_number

Gets the pre_rules_generation_number of this EdgeVmStatus. # noqa: E501

Value of the last published pre rules generation number. # noqa: E501

Returns

The pre_rules_generation_number of this EdgeVmStatus. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.edge_vnic_address_group module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.edge_vnic_address_group.EdgeVnicAddressGroup(subnet_prefix_length=None, secondary_addresses=None, primary_address=None, subnet_mask=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EdgeVnicAddressGroup - a model defined in OpenAPI

attribute_map = {'primary_address': 'primaryAddress', 'secondary_addresses': 'secondaryAddresses', 'subnet_mask': 'subnetMask', 'subnet_prefix_length': 'subnetPrefixLength'}
openapi_types = {'primary_address': 'str', 'secondary_addresses': 'SecondaryAddresses', 'subnet_mask': 'str', 'subnet_prefix_length': 'str'}
property primary_address

Gets the primary_address of this EdgeVnicAddressGroup. # noqa: E501

Primary IP address of the vnic interface. Required. # noqa: E501

Returns

The primary_address of this EdgeVnicAddressGroup. # noqa: E501

Return type

str

property secondary_addresses

Gets the secondary_addresses of this EdgeVnicAddressGroup. # noqa: E501

Returns

The secondary_addresses of this EdgeVnicAddressGroup. # noqa: E501

Return type

SecondaryAddresses

property subnet_mask

Gets the subnet_mask of this EdgeVnicAddressGroup. # noqa: E501

Returns

The subnet_mask of this EdgeVnicAddressGroup. # noqa: E501

Return type

str

property subnet_prefix_length

Gets the subnet_prefix_length of this EdgeVnicAddressGroup. # noqa: E501

Subnet prefix length of the primary IP address. # noqa: E501

Returns

The subnet_prefix_length of this EdgeVnicAddressGroup. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.edge_vnic_address_groups module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.edge_vnic_address_groups.EdgeVnicAddressGroups(address_groups=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EdgeVnicAddressGroups - a model defined in OpenAPI

property address_groups

Gets the address_groups of this EdgeVnicAddressGroups. # noqa: E501

Address group configuration of the NSX Edge vnic. Vnic can be configured to have more than one address group/subnets. # noqa: E501

Returns

The address_groups of this EdgeVnicAddressGroups. # noqa: E501

Return type

list[EdgeVnicAddressGroup]

attribute_map = {'address_groups': 'addressGroups'}
openapi_types = {'address_groups': 'list[EdgeVnicAddressGroup]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.eni_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.eni_info.EniInfo(subnet_id=None, id=None, security_group_id=None, private_ip=None, mac_address=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EniInfo - a model defined in OpenAPI

attribute_map = {'id': 'id', 'mac_address': 'mac_address', 'private_ip': 'private_ip', 'security_group_id': 'security_group_id', 'subnet_id': 'subnet_id'}
property id

Gets the id of this EniInfo. # noqa: E501

Interface ID. # noqa: E501

Returns

The id of this EniInfo. # noqa: E501

Return type

str

property mac_address

Gets the mac_address of this EniInfo. # noqa: E501

Mac address of nic. # noqa: E501

Returns

The mac_address of this EniInfo. # noqa: E501

Return type

str

openapi_types = {'id': 'str', 'mac_address': 'str', 'private_ip': 'str', 'security_group_id': 'str', 'subnet_id': 'str'}
property private_ip

Gets the private_ip of this EniInfo. # noqa: E501

Private ip of eni. # noqa: E501

Returns

The private_ip of this EniInfo. # noqa: E501

Return type

str

property security_group_id

Gets the security_group_id of this EniInfo. # noqa: E501

Security Group of Eni. # noqa: E501

Returns

The security_group_id of this EniInfo. # noqa: E501

Return type

str

property subnet_id

Gets the subnet_id of this EniInfo. # noqa: E501

Subnet it belongs to. # noqa: E501

Returns

The subnet_id of this EniInfo. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.entity_capacity module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.entity_capacity.EntityCapacity(storage_capacity_gib=None, memory_capacity_gib=None, total_number_of_cores=None, number_of_ssds=None, cpu_capacity_ghz=None, number_of_sockets=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EntityCapacity - a model defined in OpenAPI

attribute_map = {'cpu_capacity_ghz': 'cpu_capacity_ghz', 'memory_capacity_gib': 'memory_capacity_gib', 'number_of_sockets': 'number_of_sockets', 'number_of_ssds': 'number_of_ssds', 'storage_capacity_gib': 'storage_capacity_gib', 'total_number_of_cores': 'total_number_of_cores'}
property cpu_capacity_ghz

Gets the cpu_capacity_ghz of this EntityCapacity. # noqa: E501

The CPU capacity for the given entity in Ghz. # noqa: E501

Returns

The cpu_capacity_ghz of this EntityCapacity. # noqa: E501

Return type

float

property memory_capacity_gib

Gets the memory_capacity_gib of this EntityCapacity. # noqa: E501

The memory capacity for the given entity in GiB. # noqa: E501

Returns

The memory_capacity_gib of this EntityCapacity. # noqa: E501

Return type

int

property number_of_sockets

Gets the number_of_sockets of this EntityCapacity. # noqa: E501

The number of sockets for the given entity. # noqa: E501

Returns

The number_of_sockets of this EntityCapacity. # noqa: E501

Return type

int

property number_of_ssds

Gets the number_of_ssds of this EntityCapacity. # noqa: E501

The number of SSDs for the given entity. # noqa: E501

Returns

The number_of_ssds of this EntityCapacity. # noqa: E501

Return type

int

openapi_types = {'cpu_capacity_ghz': 'float', 'memory_capacity_gib': 'int', 'number_of_sockets': 'int', 'number_of_ssds': 'int', 'storage_capacity_gib': 'int', 'total_number_of_cores': 'int'}
property storage_capacity_gib

Gets the storage_capacity_gib of this EntityCapacity. # noqa: E501

The storage capacity for the given entity in GiB. # noqa: E501

Returns

The storage_capacity_gib of this EntityCapacity. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property total_number_of_cores

Gets the total_number_of_cores of this EntityCapacity. # noqa: E501

The number of CPU cores for the given entity. # noqa: E501

Returns

The total_number_of_cores of this EntityCapacity. # noqa: E501

Return type

int

vmware.vmc.console.models.error_response module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.error_response.ErrorResponse(status=None, path=None, retryable=False, error_code=None, error_messages=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ErrorResponse - a model defined in OpenAPI

attribute_map = {'error_code': 'error_code', 'error_messages': 'error_messages', 'path': 'path', 'retryable': 'retryable', 'status': 'status'}
property error_code

Gets the error_code of this ErrorResponse. # noqa: E501

unique error code # noqa: E501

Returns

The error_code of this ErrorResponse. # noqa: E501

Return type

str

property error_messages

Gets the error_messages of this ErrorResponse. # noqa: E501

localized error messages # noqa: E501

Returns

The error_messages of this ErrorResponse. # noqa: E501

Return type

list[str]

openapi_types = {'error_code': 'str', 'error_messages': 'list[str]', 'path': 'str', 'retryable': 'bool', 'status': 'int'}
property path

Gets the path of this ErrorResponse. # noqa: E501

Originating request URI # noqa: E501

Returns

The path of this ErrorResponse. # noqa: E501

Return type

str

property retryable

Gets the retryable of this ErrorResponse. # noqa: E501

If true, client should retry operation # noqa: E501

Returns

The retryable of this ErrorResponse. # noqa: E501

Return type

bool

property status

Gets the status of this ErrorResponse. # noqa: E501

HTTP status code # noqa: E501

Returns

The status of this ErrorResponse. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.esx_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.esx_config.EsxConfig(availability_zone=None, strict_placement=None, cluster_id=None, esxs=None, num_hosts=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EsxConfig - a model defined in OpenAPI

attribute_map = {'availability_zone': 'availability_zone', 'cluster_id': 'cluster_id', 'esxs': 'esxs', 'num_hosts': 'num_hosts', 'strict_placement': 'strict_placement'}
property availability_zone

Gets the availability_zone of this EsxConfig. # noqa: E501

Availability zone where the hosts should be provisioned. (Can be specified only for privileged host operations). # noqa: E501

Returns

The availability_zone of this EsxConfig. # noqa: E501

Return type

str

property cluster_id

Gets the cluster_id of this EsxConfig. # noqa: E501

An optional cluster id if the esxs operation has to be on a specific cluster. # noqa: E501

Returns

The cluster_id of this EsxConfig. # noqa: E501

Return type

str

property esxs

Gets the esxs of this EsxConfig. # noqa: E501

An optional list of ESX IDs to remove. # noqa: E501

Returns

The esxs of this EsxConfig. # noqa: E501

Return type

list[str]

property num_hosts

Gets the num_hosts of this EsxConfig. # noqa: E501

Returns

The num_hosts of this EsxConfig. # noqa: E501

Return type

int

openapi_types = {'availability_zone': 'str', 'cluster_id': 'str', 'esxs': 'list[str]', 'num_hosts': 'int', 'strict_placement': 'bool'}
property strict_placement

Gets the strict_placement of this EsxConfig. # noqa: E501

An option to indicate if the host needs to be strictly placed in a placement group. Fail the operation otherwise. # noqa: E501

Returns

The strict_placement of this EsxConfig. # noqa: E501

Return type

bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.esx_host module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.esx_host.EsxHost(name=None, availability_zone=None, esx_id=None, hostname=None, provider=None, instance_type=None, mac_address=None, custom_properties=None, esx_state=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EsxHost - a model defined in OpenAPI

attribute_map = {'availability_zone': 'availability_zone', 'custom_properties': 'custom_properties', 'esx_id': 'esx_id', 'esx_state': 'esx_state', 'hostname': 'hostname', 'instance_type': 'instance_type', 'mac_address': 'mac_address', 'name': 'name', 'provider': 'provider'}
property availability_zone

Gets the availability_zone of this EsxHost. # noqa: E501

Availability zone where the host is provisioned. # noqa: E501

Returns

The availability_zone of this EsxHost. # noqa: E501

Return type

str

property custom_properties

Gets the custom_properties of this EsxHost. # noqa: E501

Returns

The custom_properties of this EsxHost. # noqa: E501

Return type

dict(str, str)

discriminator_value_class_map = {'AwsEsxHost': 'AwsEsxHost'}
property esx_id

Gets the esx_id of this EsxHost. # noqa: E501

Returns

The esx_id of this EsxHost. # noqa: E501

Return type

str

property esx_state

Gets the esx_state of this EsxHost. # noqa: E501

Returns

The esx_state of this EsxHost. # noqa: E501

Return type

str

get_real_child_model(data)

Returns the real base class specified by the discriminator

property hostname

Gets the hostname of this EsxHost. # noqa: E501

Returns

The hostname of this EsxHost. # noqa: E501

Return type

str

property instance_type

Gets the instance_type of this EsxHost. # noqa: E501

Backing cloud provider instance type for host. # noqa: E501

Returns

The instance_type of this EsxHost. # noqa: E501

Return type

str

property mac_address

Gets the mac_address of this EsxHost. # noqa: E501

Returns

The mac_address of this EsxHost. # noqa: E501

Return type

str

property name

Gets the name of this EsxHost. # noqa: E501

Returns

The name of this EsxHost. # noqa: E501

Return type

str

openapi_types = {'availability_zone': 'str', 'custom_properties': 'dict(str, str)', 'esx_id': 'str', 'esx_state': 'str', 'hostname': 'str', 'instance_type': 'str', 'mac_address': 'str', 'name': 'str', 'provider': 'str'}
property provider

Gets the provider of this EsxHost. # noqa: E501

Returns

The provider of this EsxHost. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.esx_host_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.esx_host_info.EsxHostInfo(instance_type=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

EsxHostInfo - a model defined in OpenAPI

attribute_map = {'instance_type': 'instance_type'}
property instance_type

Gets the instance_type of this EsxHostInfo. # noqa: E501

Backing cloud provider instance type for cluster. # noqa: E501

Returns

The instance_type of this EsxHostInfo. # noqa: E501

Return type

str

openapi_types = {'instance_type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.extended_attribute module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.extended_attribute.ExtendedAttribute(name=None, value=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ExtendedAttribute - a model defined in OpenAPI

attribute_map = {'name': 'name', 'value': 'value'}
property name

Gets the name of this ExtendedAttribute. # noqa: E501

Returns

The name of this ExtendedAttribute. # noqa: E501

Return type

str

openapi_types = {'name': 'str', 'value': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this ExtendedAttribute. # noqa: E501

Returns

The value of this ExtendedAttribute. # noqa: E501

Return type

str

vmware.vmc.console.models.feature_capabilities module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.feature_capabilities.FeatureCapabilities(timestamp=None, feature_capabilities=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FeatureCapabilities - a model defined in OpenAPI

attribute_map = {'feature_capabilities': 'featureCapabilities', 'timestamp': 'timestamp'}
property feature_capabilities

Gets the feature_capabilities of this FeatureCapabilities. # noqa: E501

List of feature capability information. # noqa: E501

Returns

The feature_capabilities of this FeatureCapabilities. # noqa: E501

Return type

list[FeatureCapability]

openapi_types = {'feature_capabilities': 'list[FeatureCapability]', 'timestamp': 'int'}
property timestamp

Gets the timestamp of this FeatureCapabilities. # noqa: E501

Time stamp value at which the feature capabilities were retrieved. # noqa: E501

Returns

The timestamp of this FeatureCapabilities. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.feature_capability module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.feature_capability.FeatureCapability(configuration_limits=None, is_supported=None, service=None, permission=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FeatureCapability - a model defined in OpenAPI

attribute_map = {'configuration_limits': 'configurationLimits', 'is_supported': 'isSupported', 'permission': 'permission', 'service': 'service'}
property configuration_limits

Gets the configuration_limits of this FeatureCapability. # noqa: E501

List of key value pairs describing the feature configuration limits. # noqa: E501

Returns

The configuration_limits of this FeatureCapability. # noqa: E501

Return type

list[KeyValueAttributes]

property is_supported

Gets the is_supported of this FeatureCapability. # noqa: E501

Value is true if feature is supported on NSX Edge. # noqa: E501

Returns

The is_supported of this FeatureCapability. # noqa: E501

Return type

bool

openapi_types = {'configuration_limits': 'list[KeyValueAttributes]', 'is_supported': 'bool', 'permission': 'LicenceAclPermissions', 'service': 'str'}
property permission

Gets the permission of this FeatureCapability. # noqa: E501

Returns

The permission of this FeatureCapability. # noqa: E501

Return type

LicenceAclPermissions

property service

Gets the service of this FeatureCapability. # noqa: E501

Name of the feature or service. # noqa: E501

Returns

The service of this FeatureCapability. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.feature_status module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.feature_status.FeatureStatus(status=None, configured=None, server_status=None, publish_status=None, service=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FeatureStatus - a model defined in OpenAPI

attribute_map = {'configured': 'configured', 'publish_status': 'publishStatus', 'server_status': 'serverStatus', 'service': 'service', 'status': 'status'}
property configured

Gets the configured of this FeatureStatus. # noqa: E501

Value is true if feature is configured. # noqa: E501

Returns

The configured of this FeatureStatus. # noqa: E501

Return type

bool

openapi_types = {'configured': 'bool', 'publish_status': 'str', 'server_status': 'str', 'service': 'str', 'status': 'str'}
property publish_status

Gets the publish_status of this FeatureStatus. # noqa: E501

Publish status of the feature, whether APPLIED or PERSISTED. # noqa: E501

Returns

The publish_status of this FeatureStatus. # noqa: E501

Return type

str

property server_status

Gets the server_status of this FeatureStatus. # noqa: E501

Server status of the feature or service. Values are up and down. # noqa: E501

Returns

The server_status of this FeatureStatus. # noqa: E501

Return type

str

property service

Gets the service of this FeatureStatus. # noqa: E501

Name of the feature or service. # noqa: E501

Returns

The service of this FeatureStatus. # noqa: E501

Return type

str

property status

Gets the status of this FeatureStatus. # noqa: E501

Status of the feature or service. # noqa: E501

Returns

The status of this FeatureStatus. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.firewall_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.firewall_config.FirewallConfig(firewall_rules=None, feature_type=None, version=None, template=None, global_config=None, enabled=None, default_policy=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FirewallConfig - a model defined in OpenAPI

attribute_map = {'default_policy': 'defaultPolicy', 'enabled': 'enabled', 'feature_type': 'featureType', 'firewall_rules': 'firewallRules', 'global_config': 'globalConfig', 'template': 'template', 'version': 'version'}
property default_policy

Gets the default_policy of this FirewallConfig. # noqa: E501

Returns

The default_policy of this FirewallConfig. # noqa: E501

Return type

FirewallDefaultPolicy

property enabled

Gets the enabled of this FirewallConfig. # noqa: E501

Value is true if feature is enabled. Default value is true. Optional. # noqa: E501

Returns

The enabled of this FirewallConfig. # noqa: E501

Return type

bool

property feature_type

Gets the feature_type of this FirewallConfig. # noqa: E501

Returns

The feature_type of this FirewallConfig. # noqa: E501

Return type

str

property firewall_rules

Gets the firewall_rules of this FirewallConfig. # noqa: E501

Returns

The firewall_rules of this FirewallConfig. # noqa: E501

Return type

FirewallRules

property global_config

Gets the global_config of this FirewallConfig. # noqa: E501

Returns

The global_config of this FirewallConfig. # noqa: E501

Return type

FirewallGlobalConfig

openapi_types = {'default_policy': 'FirewallDefaultPolicy', 'enabled': 'bool', 'feature_type': 'str', 'firewall_rules': 'FirewallRules', 'global_config': 'FirewallGlobalConfig', 'template': 'str', 'version': 'int'}
property template

Gets the template of this FirewallConfig. # noqa: E501

Returns

The template of this FirewallConfig. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this FirewallConfig. # noqa: E501

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. # noqa: E501

Returns

The version of this FirewallConfig. # noqa: E501

Return type

int

vmware.vmc.console.models.firewall_dashboard_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.firewall_dashboard_stats.FirewallDashboardStats(connections=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FirewallDashboardStats - a model defined in OpenAPI

attribute_map = {'connections': 'connections'}
property connections

Gets the connections of this FirewallDashboardStats. # noqa: E501

Number of NSX Edge firewall connections and rules. # noqa: E501

Returns

The connections of this FirewallDashboardStats. # noqa: E501

Return type

list[DashboardStat]

openapi_types = {'connections': 'list[DashboardStat]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.firewall_default_policy module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.firewall_default_policy.FirewallDefaultPolicy(action=None, logging_enabled=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FirewallDefaultPolicy - a model defined in OpenAPI

property action

Gets the action of this FirewallDefaultPolicy. # noqa: E501

Action. Default is deny. Supported values accept, deny # noqa: E501

Returns

The action of this FirewallDefaultPolicy. # noqa: E501

Return type

str

attribute_map = {'action': 'action', 'logging_enabled': 'loggingEnabled'}
property logging_enabled

Gets the logging_enabled of this FirewallDefaultPolicy. # noqa: E501

Enable logging for the rule. # noqa: E501

Returns

The logging_enabled of this FirewallDefaultPolicy. # noqa: E501

Return type

bool

openapi_types = {'action': 'str', 'logging_enabled': 'bool'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.firewall_global_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.firewall_global_config.FirewallGlobalConfig(tcp_allow_out_of_window_packets=None, udp_timeout=None, ip_generic_timeout=None, tcp_pick_ongoing_connections=None, tcp_timeout_open=None, tcp_timeout_close=None, icmp6_timeout=None, drop_icmp_replays=None, log_icmp_errors=None, tcp_send_reset_for_closed_vse_ports=None, drop_invalid_traffic=None, enable_syn_flood_protection=None, icmp_timeout=None, tcp_timeout_established=None, log_invalid_traffic=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FirewallGlobalConfig - a model defined in OpenAPI

attribute_map = {'drop_icmp_replays': 'dropIcmpReplays', 'drop_invalid_traffic': 'dropInvalidTraffic', 'enable_syn_flood_protection': 'enableSynFloodProtection', 'icmp6_timeout': 'icmp6Timeout', 'icmp_timeout': 'icmpTimeout', 'ip_generic_timeout': 'ipGenericTimeout', 'log_icmp_errors': 'logIcmpErrors', 'log_invalid_traffic': 'logInvalidTraffic', 'tcp_allow_out_of_window_packets': 'tcpAllowOutOfWindowPackets', 'tcp_pick_ongoing_connections': 'tcpPickOngoingConnections', 'tcp_send_reset_for_closed_vse_ports': 'tcpSendResetForClosedVsePorts', 'tcp_timeout_close': 'tcpTimeoutClose', 'tcp_timeout_established': 'tcpTimeoutEstablished', 'tcp_timeout_open': 'tcpTimeoutOpen', 'udp_timeout': 'udpTimeout'}
property drop_icmp_replays

Gets the drop_icmp_replays of this FirewallGlobalConfig. # noqa: E501

Drop icmp replays. # noqa: E501

Returns

The drop_icmp_replays of this FirewallGlobalConfig. # noqa: E501

Return type

bool

property drop_invalid_traffic

Gets the drop_invalid_traffic of this FirewallGlobalConfig. # noqa: E501

Drop invalid traffic. # noqa: E501

Returns

The drop_invalid_traffic of this FirewallGlobalConfig. # noqa: E501

Return type

bool

property enable_syn_flood_protection

Gets the enable_syn_flood_protection of this FirewallGlobalConfig. # noqa: E501

Protect against SYN flood attacks by detecting bogus TCP connections and terminating them without consuming firewall state tracking resources. Default : false # noqa: E501

Returns

The enable_syn_flood_protection of this FirewallGlobalConfig. # noqa: E501

Return type

bool

property icmp6_timeout

Gets the icmp6_timeout of this FirewallGlobalConfig. # noqa: E501

ICMP6 timeout. # noqa: E501

Returns

The icmp6_timeout of this FirewallGlobalConfig. # noqa: E501

Return type

int

property icmp_timeout

Gets the icmp_timeout of this FirewallGlobalConfig. # noqa: E501

ICMP timeout. # noqa: E501

Returns

The icmp_timeout of this FirewallGlobalConfig. # noqa: E501

Return type

int

property ip_generic_timeout

Gets the ip_generic_timeout of this FirewallGlobalConfig. # noqa: E501

IP generic timeout. # noqa: E501

Returns

The ip_generic_timeout of this FirewallGlobalConfig. # noqa: E501

Return type

int

property log_icmp_errors

Gets the log_icmp_errors of this FirewallGlobalConfig. # noqa: E501

Log icmp errors. # noqa: E501

Returns

The log_icmp_errors of this FirewallGlobalConfig. # noqa: E501

Return type

bool

property log_invalid_traffic

Gets the log_invalid_traffic of this FirewallGlobalConfig. # noqa: E501

Log invalid traffic. # noqa: E501

Returns

The log_invalid_traffic of this FirewallGlobalConfig. # noqa: E501

Return type

bool

openapi_types = {'drop_icmp_replays': 'bool', 'drop_invalid_traffic': 'bool', 'enable_syn_flood_protection': 'bool', 'icmp6_timeout': 'int', 'icmp_timeout': 'int', 'ip_generic_timeout': 'int', 'log_icmp_errors': 'bool', 'log_invalid_traffic': 'bool', 'tcp_allow_out_of_window_packets': 'bool', 'tcp_pick_ongoing_connections': 'bool', 'tcp_send_reset_for_closed_vse_ports': 'bool', 'tcp_timeout_close': 'int', 'tcp_timeout_established': 'int', 'tcp_timeout_open': 'int', 'udp_timeout': 'int'}
property tcp_allow_out_of_window_packets

Gets the tcp_allow_out_of_window_packets of this FirewallGlobalConfig. # noqa: E501

Allow TCP out of window packets. # noqa: E501

Returns

The tcp_allow_out_of_window_packets of this FirewallGlobalConfig. # noqa: E501

Return type

bool

property tcp_pick_ongoing_connections

Gets the tcp_pick_ongoing_connections of this FirewallGlobalConfig. # noqa: E501

Pick TCP ongoing connections. # noqa: E501

Returns

The tcp_pick_ongoing_connections of this FirewallGlobalConfig. # noqa: E501

Return type

bool

property tcp_send_reset_for_closed_vse_ports

Gets the tcp_send_reset_for_closed_vse_ports of this FirewallGlobalConfig. # noqa: E501

Send TCP reset for closed NSX Edge ports. # noqa: E501

Returns

The tcp_send_reset_for_closed_vse_ports of this FirewallGlobalConfig. # noqa: E501

Return type

bool

property tcp_timeout_close

Gets the tcp_timeout_close of this FirewallGlobalConfig. # noqa: E501

TCP timeout close. # noqa: E501

Returns

The tcp_timeout_close of this FirewallGlobalConfig. # noqa: E501

Return type

int

property tcp_timeout_established

Gets the tcp_timeout_established of this FirewallGlobalConfig. # noqa: E501

TCP timeout established. # noqa: E501

Returns

The tcp_timeout_established of this FirewallGlobalConfig. # noqa: E501

Return type

int

property tcp_timeout_open

Gets the tcp_timeout_open of this FirewallGlobalConfig. # noqa: E501

TCP timeout open. # noqa: E501

Returns

The tcp_timeout_open of this FirewallGlobalConfig. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property udp_timeout

Gets the udp_timeout of this FirewallGlobalConfig. # noqa: E501

UDP timeout close. # noqa: E501

Returns

The udp_timeout of this FirewallGlobalConfig. # noqa: E501

Return type

int

vmware.vmc.console.models.firewall_rule module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.firewall_rule.FirewallRule(rule_type=None, application_ids=None, name=None, rule_interface=None, destination=None, id=None, destination_scope=None, source=None, source_scope=None, services=None, action=None, revision=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FirewallRule - a model defined in OpenAPI

property action

Gets the action of this FirewallRule. # noqa: E501

Returns

The action of this FirewallRule. # noqa: E501

Return type

str

property application_ids

Gets the application_ids of this FirewallRule. # noqa: E501

Returns

The application_ids of this FirewallRule. # noqa: E501

Return type

list[str]

attribute_map = {'action': 'action', 'application_ids': 'application_ids', 'destination': 'destination', 'destination_scope': 'destination_scope', 'id': 'id', 'name': 'name', 'revision': 'revision', 'rule_interface': 'rule_interface', 'rule_type': 'rule_type', 'services': 'services', 'source': 'source', 'source_scope': 'source_scope'}
property destination

Gets the destination of this FirewallRule. # noqa: E501

Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated list of those entries. If not specified, defaults to ‘any’. # noqa: E501

Returns

The destination of this FirewallRule. # noqa: E501

Return type

str

property destination_scope

Gets the destination_scope of this FirewallRule. # noqa: E501

Returns

The destination_scope of this FirewallRule. # noqa: E501

Return type

FirewallRuleScope

property id

Gets the id of this FirewallRule. # noqa: E501

Returns

The id of this FirewallRule. # noqa: E501

Return type

str

property name

Gets the name of this FirewallRule. # noqa: E501

Returns

The name of this FirewallRule. # noqa: E501

Return type

str

openapi_types = {'action': 'str', 'application_ids': 'list[str]', 'destination': 'str', 'destination_scope': 'FirewallRuleScope', 'id': 'str', 'name': 'str', 'revision': 'int', 'rule_interface': 'str', 'rule_type': 'str', 'services': 'list[FirewallService]', 'source': 'str', 'source_scope': 'FirewallRuleScope'}
property revision

Gets the revision of this FirewallRule. # noqa: E501

current revision of the list of firewall rules, used to protect against concurrent modification (first writer wins) # noqa: E501

Returns

The revision of this FirewallRule. # noqa: E501

Return type

int

property rule_interface

Gets the rule_interface of this FirewallRule. # noqa: E501

Deprecated, left for backwards compatibility. Remove once UI stops using it. # noqa: E501

Returns

The rule_interface of this FirewallRule. # noqa: E501

Return type

str

property rule_type

Gets the rule_type of this FirewallRule. # noqa: E501

Returns

The rule_type of this FirewallRule. # noqa: E501

Return type

str

property services

Gets the services of this FirewallRule. # noqa: E501

list of protocols and ports for this firewall rule # noqa: E501

Returns

The services of this FirewallRule. # noqa: E501

Return type

list[FirewallService]

property source

Gets the source of this FirewallRule. # noqa: E501

Optional. Possible formats are IP, IP1-IPn, CIDR or comma separated list of those entries. If not specified, defaults to ‘any’. # noqa: E501

Returns

The source of this FirewallRule. # noqa: E501

Return type

str

property source_scope

Gets the source_scope of this FirewallRule. # noqa: E501

Returns

The source_scope of this FirewallRule. # noqa: E501

Return type

FirewallRuleScope

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.firewall_rule_scope module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.firewall_rule_scope.FirewallRuleScope(grouping_object_ids=None, vnic_group_ids=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FirewallRuleScope - a model defined in OpenAPI

attribute_map = {'grouping_object_ids': 'grouping_object_ids', 'vnic_group_ids': 'vnic_group_ids'}
property grouping_object_ids

Gets the grouping_object_ids of this FirewallRuleScope. # noqa: E501

Returns

The grouping_object_ids of this FirewallRuleScope. # noqa: E501

Return type

list[str]

openapi_types = {'grouping_object_ids': 'list[str]', 'vnic_group_ids': 'list[str]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vnic_group_ids

Gets the vnic_group_ids of this FirewallRuleScope. # noqa: E501

Returns

The vnic_group_ids of this FirewallRuleScope. # noqa: E501

Return type

list[str]

vmware.vmc.console.models.firewall_rule_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.firewall_rule_stats.FirewallRuleStats(timestamp=None, connection_count=None, byte_count=None, packet_count=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FirewallRuleStats - a model defined in OpenAPI

attribute_map = {'byte_count': 'byteCount', 'connection_count': 'connectionCount', 'packet_count': 'packetCount', 'timestamp': 'timestamp'}
property byte_count

Gets the byte_count of this FirewallRuleStats. # noqa: E501

Byte count. # noqa: E501

Returns

The byte_count of this FirewallRuleStats. # noqa: E501

Return type

int

property connection_count

Gets the connection_count of this FirewallRuleStats. # noqa: E501

Connection count. # noqa: E501

Returns

The connection_count of this FirewallRuleStats. # noqa: E501

Return type

int

openapi_types = {'byte_count': 'int', 'connection_count': 'int', 'packet_count': 'int', 'timestamp': 'int'}
property packet_count

Gets the packet_count of this FirewallRuleStats. # noqa: E501

Packet count. # noqa: E501

Returns

The packet_count of this FirewallRuleStats. # noqa: E501

Return type

int

property timestamp

Gets the timestamp of this FirewallRuleStats. # noqa: E501

Timestamp of statistics collection. # noqa: E501

Returns

The timestamp of this FirewallRuleStats. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.firewall_rules module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.firewall_rules.FirewallRules(firewall_rules=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FirewallRules - a model defined in OpenAPI

attribute_map = {'firewall_rules': 'firewallRules'}
property firewall_rules

Gets the firewall_rules of this FirewallRules. # noqa: E501

Ordered list of firewall rules. # noqa: E501

Returns

The firewall_rules of this FirewallRules. # noqa: E501

Return type

list[Nsxfirewallrule]

openapi_types = {'firewall_rules': 'list[Nsxfirewallrule]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.firewall_service module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.firewall_service.FirewallService(protocol=None, ports=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

FirewallService - a model defined in OpenAPI

attribute_map = {'ports': 'ports', 'protocol': 'protocol'}
openapi_types = {'ports': 'list[str]', 'protocol': 'str'}
property ports

Gets the ports of this FirewallService. # noqa: E501

a list of port numbers and port ranges, such as {80, 91-95, 99}. If not specified, defaults to ‘any’. # noqa: E501

Returns

The ports of this FirewallService. # noqa: E501

Return type

list[str]

property protocol

Gets the protocol of this FirewallService. # noqa: E501

protocol name, such as ‘tcp’, ‘udp’ etc. # noqa: E501

Returns

The protocol of this FirewallService. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.gateway_template module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.gateway_template.GatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

GatewayTemplate - a model defined in OpenAPI

attribute_map = {'firewall_rules': 'firewall_rules', 'primary_dns': 'primary_dns', 'public_ip': 'public_ip', 'secondary_dns': 'secondary_dns', 'vpns': 'vpns'}
property firewall_rules

Gets the firewall_rules of this GatewayTemplate. # noqa: E501

Returns

The firewall_rules of this GatewayTemplate. # noqa: E501

Return type

list[FirewallRule]

openapi_types = {'firewall_rules': 'list[FirewallRule]', 'primary_dns': 'str', 'public_ip': 'SddcPublicIp', 'secondary_dns': 'str', 'vpns': 'list[Vpn]'}
property primary_dns

Gets the primary_dns of this GatewayTemplate. # noqa: E501

Returns

The primary_dns of this GatewayTemplate. # noqa: E501

Return type

str

property public_ip

Gets the public_ip of this GatewayTemplate. # noqa: E501

Returns

The public_ip of this GatewayTemplate. # noqa: E501

Return type

SddcPublicIp

property secondary_dns

Gets the secondary_dns of this GatewayTemplate. # noqa: E501

Returns

The secondary_dns of this GatewayTemplate. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpns

Gets the vpns of this GatewayTemplate. # noqa: E501

Returns

The vpns of this GatewayTemplate. # noqa: E501

Return type

list[Vpn]

vmware.vmc.console.models.glcm_bundle module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.glcm_bundle.GlcmBundle(s3_bucket=None, id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

GlcmBundle - a model defined in OpenAPI

attribute_map = {'id': 'id', 's3_bucket': 's3Bucket'}
property id

Gets the id of this GlcmBundle. # noqa: E501

the glcmbundle’s id # noqa: E501

Returns

The id of this GlcmBundle. # noqa: E501

Return type

str

openapi_types = {'id': 'str', 's3_bucket': 'str'}
property s3_bucket

Gets the s3_bucket of this GlcmBundle. # noqa: E501

the glcmbundle’s s3 bucket # noqa: E501

Returns

The s3_bucket of this GlcmBundle. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.host_instance_types module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.host_instance_types.HostInstanceTypes(local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

HostInstanceTypes - a model defined in OpenAPI

I3EN_METAL = 'i3en.metal'
I3_METAL = 'i3.metal'
R5_METAL = 'r5.metal'
allowable_values = ['i3.metal', 'r5.metal', 'i3en.metal']
Attributes:
openapi_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}
openapi_types = {}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.host_lease_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.host_lease_info.HostLeaseInfo(mac_address=None, ends=None, abandoned=None, cltt=None, client_hostname=None, starts=None, binding_state=None, hardware_type=None, tsfp=None, uid=None, next_binding_state=None, ip_address=None, tstp=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

HostLeaseInfo - a model defined in OpenAPI

property abandoned

Gets the abandoned of this HostLeaseInfo. # noqa: E501

Time stamp of when IP address was marked as abandoned. # noqa: E501

Returns

The abandoned of this HostLeaseInfo. # noqa: E501

Return type

str

attribute_map = {'abandoned': 'abandoned', 'binding_state': 'bindingState', 'client_hostname': 'clientHostname', 'cltt': 'cltt', 'ends': 'ends', 'hardware_type': 'hardwareType', 'ip_address': 'ipAddress', 'mac_address': 'macAddress', 'next_binding_state': 'nextBindingState', 'starts': 'starts', 'tsfp': 'tsfp', 'tstp': 'tstp', 'uid': 'uid'}
property binding_state

Gets the binding_state of this HostLeaseInfo. # noqa: E501

Lease’s binding state. # noqa: E501

Returns

The binding_state of this HostLeaseInfo. # noqa: E501

Return type

str

property client_hostname

Gets the client_hostname of this HostLeaseInfo. # noqa: E501

Name of the client. # noqa: E501

Returns

The client_hostname of this HostLeaseInfo. # noqa: E501

Return type

str

property cltt

Gets the cltt of this HostLeaseInfo. # noqa: E501

Client Last Transaction Time of the lease info. # noqa: E501

Returns

The cltt of this HostLeaseInfo. # noqa: E501

Return type

str

property ends

Gets the ends of this HostLeaseInfo. # noqa: E501

End time of the lease. # noqa: E501

Returns

The ends of this HostLeaseInfo. # noqa: E501

Return type

str

property hardware_type

Gets the hardware_type of this HostLeaseInfo. # noqa: E501

The hardware type on which the lease will be used. # noqa: E501

Returns

The hardware_type of this HostLeaseInfo. # noqa: E501

Return type

str

property ip_address

Gets the ip_address of this HostLeaseInfo. # noqa: E501

IP address of the client. # noqa: E501

Returns

The ip_address of this HostLeaseInfo. # noqa: E501

Return type

str

property mac_address

Gets the mac_address of this HostLeaseInfo. # noqa: E501

MAC address of the client. # noqa: E501

Returns

The mac_address of this HostLeaseInfo. # noqa: E501

Return type

str

property next_binding_state

Gets the next_binding_state of this HostLeaseInfo. # noqa: E501

Indicates what state the lease will move to when the current state expires. # noqa: E501

Returns

The next_binding_state of this HostLeaseInfo. # noqa: E501

Return type

str

openapi_types = {'abandoned': 'str', 'binding_state': 'str', 'client_hostname': 'str', 'cltt': 'str', 'ends': 'str', 'hardware_type': 'str', 'ip_address': 'str', 'mac_address': 'str', 'next_binding_state': 'str', 'starts': 'str', 'tsfp': 'str', 'tstp': 'str', 'uid': 'str'}
property starts

Gets the starts of this HostLeaseInfo. # noqa: E501

Start time of the lease. # noqa: E501

Returns

The starts of this HostLeaseInfo. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tsfp

Gets the tsfp of this HostLeaseInfo. # noqa: E501

Time Sent From Partner of the lease info. # noqa: E501

Returns

The tsfp of this HostLeaseInfo. # noqa: E501

Return type

str

property tstp

Gets the tstp of this HostLeaseInfo. # noqa: E501

Time Sent To Partner of the lease info. # noqa: E501

Returns

The tstp of this HostLeaseInfo. # noqa: E501

Return type

str

property uid

Gets the uid of this HostLeaseInfo. # noqa: E501

Uid to identify the DHCP lease. # noqa: E501

Returns

The uid of this HostLeaseInfo. # noqa: E501

Return type

str

vmware.vmc.console.models.instance_type_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.instance_type_config.InstanceTypeConfig(instance_type=None, hosts=None, display_name=None, entity_capacity=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

InstanceTypeConfig - a model defined in OpenAPI

attribute_map = {'display_name': 'display_name', 'entity_capacity': 'entity_capacity', 'hosts': 'hosts', 'instance_type': 'instance_type'}
property display_name

Gets the display_name of this InstanceTypeConfig. # noqa: E501

Display name of instance_type. # noqa: E501

Returns

The display_name of this InstanceTypeConfig. # noqa: E501

Return type

str

property entity_capacity

Gets the entity_capacity of this InstanceTypeConfig. # noqa: E501

Returns

The entity_capacity of this InstanceTypeConfig. # noqa: E501

Return type

EntityCapacity

property hosts

Gets the hosts of this InstanceTypeConfig. # noqa: E501

Array of number of hosts allowed for this operation. Range of hosts user can select for sddc provision # noqa: E501

Returns

The hosts of this InstanceTypeConfig. # noqa: E501

Return type

list[int]

property instance_type

Gets the instance_type of this InstanceTypeConfig. # noqa: E501

Instance type name. # noqa: E501

Returns

The instance_type of this InstanceTypeConfig. # noqa: E501

Return type

str

openapi_types = {'display_name': 'str', 'entity_capacity': 'EntityCapacity', 'hosts': 'list[int]', 'instance_type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.interaction_permissions module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.interaction_permissions.InteractionPermissions(manage_permission=None, view_permission=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

InteractionPermissions - a model defined in OpenAPI

attribute_map = {'manage_permission': 'managePermission', 'view_permission': 'viewPermission'}
property manage_permission

Gets the manage_permission of this InteractionPermissions. # noqa: E501

Returns

The manage_permission of this InteractionPermissions. # noqa: E501

Return type

bool

openapi_types = {'manage_permission': 'bool', 'view_permission': 'bool'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property view_permission

Gets the view_permission of this InteractionPermissions. # noqa: E501

Returns

The view_permission of this InteractionPermissions. # noqa: E501

Return type

bool

vmware.vmc.console.models.interfaces_dashboard_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.interfaces_dashboard_stats.InterfacesDashboardStats(vnic_7_in_pkt=None, vnic_0_in_byte=None, vnic_8_out_pkt=None, vnic_5_in_byte=None, vnic_2_in_pkt=None, vnic_3_in_pkt=None, vnic_6_out_byte=None, vnic_3_in_byte=None, vnic_8_in_pkt=None, vnic_1_in_byte=None, vnic_1_out_pkt=None, vnic_5_out_byte=None, vnic_0_out_pkt=None, vnic_0_out_byte=None, vnic_6_out_pkt=None, vnic_3_out_byte=None, vnic_7_in_byte=None, vnic_1_out_byte=None, vnic_9_out_pkt=None, vnic_9_in_pkt=None, vnic_4_in_byte=None, vnic_5_out_pkt=None, vnic_2_out_pkt=None, vnic_2_in_byte=None, vnic_5_in_pkt=None, vnic_7_out_pkt=None, vnic_3_out_pkt=None, vnic_4_out_pkt=None, vnic_4_out_byte=None, vnic_1_in_pkt=None, vnic_2_out_byte=None, vnic_6_in_byte=None, vnic_0_in_pkt=None, vnic_9_in_byte=None, vnic_7_out_byte=None, vnic_4_in_pkt=None, vnic_9_out_byte=None, vnic_8_out_byte=None, vnic_8_in_byte=None, vnic_6_in_pkt=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

InterfacesDashboardStats - a model defined in OpenAPI

attribute_map = {'vnic_0_in_byte': 'vnic_0_in_byte', 'vnic_0_in_pkt': 'vnic_0_in_pkt', 'vnic_0_out_byte': 'vnic_0_out_byte', 'vnic_0_out_pkt': 'vnic_0_out_pkt', 'vnic_1_in_byte': 'vnic_1_in_byte', 'vnic_1_in_pkt': 'vnic_1_in_pkt', 'vnic_1_out_byte': 'vnic_1_out_byte', 'vnic_1_out_pkt': 'vnic_1_out_pkt', 'vnic_2_in_byte': 'vnic_2_in_byte', 'vnic_2_in_pkt': 'vnic_2_in_pkt', 'vnic_2_out_byte': 'vnic_2_out_byte', 'vnic_2_out_pkt': 'vnic_2_out_pkt', 'vnic_3_in_byte': 'vnic_3_in_byte', 'vnic_3_in_pkt': 'vnic_3_in_pkt', 'vnic_3_out_byte': 'vnic_3_out_byte', 'vnic_3_out_pkt': 'vnic_3_out_pkt', 'vnic_4_in_byte': 'vnic_4_in_byte', 'vnic_4_in_pkt': 'vnic_4_in_pkt', 'vnic_4_out_byte': 'vnic_4_out_byte', 'vnic_4_out_pkt': 'vnic_4_out_pkt', 'vnic_5_in_byte': 'vnic_5_in_byte', 'vnic_5_in_pkt': 'vnic_5_in_pkt', 'vnic_5_out_byte': 'vnic_5_out_byte', 'vnic_5_out_pkt': 'vnic_5_out_pkt', 'vnic_6_in_byte': 'vnic_6_in_byte', 'vnic_6_in_pkt': 'vnic_6_in_pkt', 'vnic_6_out_byte': 'vnic_6_out_byte', 'vnic_6_out_pkt': 'vnic_6_out_pkt', 'vnic_7_in_byte': 'vnic_7_in_byte', 'vnic_7_in_pkt': 'vnic_7_in_pkt', 'vnic_7_out_byte': 'vnic_7_out_byte', 'vnic_7_out_pkt': 'vnic_7_out_pkt', 'vnic_8_in_byte': 'vnic_8_in_byte', 'vnic_8_in_pkt': 'vnic_8_in_pkt', 'vnic_8_out_byte': 'vnic_8_out_byte', 'vnic_8_out_pkt': 'vnic_8_out_pkt', 'vnic_9_in_byte': 'vnic_9_in_byte', 'vnic_9_in_pkt': 'vnic_9_in_pkt', 'vnic_9_out_byte': 'vnic_9_out_byte', 'vnic_9_out_pkt': 'vnic_9_out_pkt'}
openapi_types = {'vnic_0_in_byte': 'list[DashboardStat]', 'vnic_0_in_pkt': 'list[DashboardStat]', 'vnic_0_out_byte': 'list[DashboardStat]', 'vnic_0_out_pkt': 'list[DashboardStat]', 'vnic_1_in_byte': 'list[DashboardStat]', 'vnic_1_in_pkt': 'list[DashboardStat]', 'vnic_1_out_byte': 'list[DashboardStat]', 'vnic_1_out_pkt': 'list[DashboardStat]', 'vnic_2_in_byte': 'list[DashboardStat]', 'vnic_2_in_pkt': 'list[DashboardStat]', 'vnic_2_out_byte': 'list[DashboardStat]', 'vnic_2_out_pkt': 'list[DashboardStat]', 'vnic_3_in_byte': 'list[DashboardStat]', 'vnic_3_in_pkt': 'list[DashboardStat]', 'vnic_3_out_byte': 'list[DashboardStat]', 'vnic_3_out_pkt': 'list[DashboardStat]', 'vnic_4_in_byte': 'list[DashboardStat]', 'vnic_4_in_pkt': 'list[DashboardStat]', 'vnic_4_out_byte': 'list[DashboardStat]', 'vnic_4_out_pkt': 'list[DashboardStat]', 'vnic_5_in_byte': 'list[DashboardStat]', 'vnic_5_in_pkt': 'list[DashboardStat]', 'vnic_5_out_byte': 'list[DashboardStat]', 'vnic_5_out_pkt': 'list[DashboardStat]', 'vnic_6_in_byte': 'list[DashboardStat]', 'vnic_6_in_pkt': 'list[DashboardStat]', 'vnic_6_out_byte': 'list[DashboardStat]', 'vnic_6_out_pkt': 'list[DashboardStat]', 'vnic_7_in_byte': 'list[DashboardStat]', 'vnic_7_in_pkt': 'list[DashboardStat]', 'vnic_7_out_byte': 'list[DashboardStat]', 'vnic_7_out_pkt': 'list[DashboardStat]', 'vnic_8_in_byte': 'list[DashboardStat]', 'vnic_8_in_pkt': 'list[DashboardStat]', 'vnic_8_out_byte': 'list[DashboardStat]', 'vnic_8_out_pkt': 'list[DashboardStat]', 'vnic_9_in_byte': 'list[DashboardStat]', 'vnic_9_in_pkt': 'list[DashboardStat]', 'vnic_9_out_byte': 'list[DashboardStat]', 'vnic_9_out_pkt': 'list[DashboardStat]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vnic_0_in_byte

Gets the vnic_0_in_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_0_in_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_0_in_pkt

Gets the vnic_0_in_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_0_in_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_0_out_byte

Gets the vnic_0_out_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_0_out_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_0_out_pkt

Gets the vnic_0_out_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_0_out_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_1_in_byte

Gets the vnic_1_in_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_1_in_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_1_in_pkt

Gets the vnic_1_in_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_1_in_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_1_out_byte

Gets the vnic_1_out_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_1_out_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_1_out_pkt

Gets the vnic_1_out_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_1_out_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_2_in_byte

Gets the vnic_2_in_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_2_in_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_2_in_pkt

Gets the vnic_2_in_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_2_in_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_2_out_byte

Gets the vnic_2_out_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_2_out_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_2_out_pkt

Gets the vnic_2_out_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_2_out_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_3_in_byte

Gets the vnic_3_in_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_3_in_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_3_in_pkt

Gets the vnic_3_in_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_3_in_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_3_out_byte

Gets the vnic_3_out_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_3_out_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_3_out_pkt

Gets the vnic_3_out_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_3_out_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_4_in_byte

Gets the vnic_4_in_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_4_in_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_4_in_pkt

Gets the vnic_4_in_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_4_in_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_4_out_byte

Gets the vnic_4_out_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_4_out_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_4_out_pkt

Gets the vnic_4_out_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_4_out_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_5_in_byte

Gets the vnic_5_in_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_5_in_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_5_in_pkt

Gets the vnic_5_in_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_5_in_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_5_out_byte

Gets the vnic_5_out_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_5_out_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_5_out_pkt

Gets the vnic_5_out_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_5_out_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_6_in_byte

Gets the vnic_6_in_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_6_in_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_6_in_pkt

Gets the vnic_6_in_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_6_in_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_6_out_byte

Gets the vnic_6_out_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_6_out_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_6_out_pkt

Gets the vnic_6_out_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_6_out_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_7_in_byte

Gets the vnic_7_in_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_7_in_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_7_in_pkt

Gets the vnic_7_in_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_7_in_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_7_out_byte

Gets the vnic_7_out_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_7_out_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_7_out_pkt

Gets the vnic_7_out_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_7_out_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_8_in_byte

Gets the vnic_8_in_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_8_in_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_8_in_pkt

Gets the vnic_8_in_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_8_in_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_8_out_byte

Gets the vnic_8_out_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_8_out_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_8_out_pkt

Gets the vnic_8_out_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_8_out_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_9_in_byte

Gets the vnic_9_in_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_9_in_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_9_in_pkt

Gets the vnic_9_in_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_9_in_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_9_out_byte

Gets the vnic_9_out_byte of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_9_out_byte of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property vnic_9_out_pkt

Gets the vnic_9_out_pkt of this InterfacesDashboardStats. # noqa: E501

Returns

The vnic_9_out_pkt of this InterfacesDashboardStats. # noqa: E501

Return type

list[DashboardStat]

vmware.vmc.console.models.ip_addresses module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ip_addresses.IpAddresses(ip_address=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

IpAddresses - a model defined in OpenAPI

attribute_map = {'ip_address': 'ipAddress'}
property ip_address

Gets the ip_address of this IpAddresses. # noqa: E501

List of IP addresses. # noqa: E501

Returns

The ip_address of this IpAddresses. # noqa: E501

Return type

list[str]

openapi_types = {'ip_address': 'list[str]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.ipsec module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ipsec.Ipsec(feature_type=None, logging=None, _global=None, enabled=None, sites=None, disable_event=None, version=None, template=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Ipsec - a model defined in OpenAPI

attribute_map = {'_global': 'global', 'disable_event': 'disableEvent', 'enabled': 'enabled', 'feature_type': 'featureType', 'logging': 'logging', 'sites': 'sites', 'template': 'template', 'version': 'version'}
property disable_event

Gets the disable_event of this Ipsec. # noqa: E501

Enable/disable event generation on NSX Edge appliance for IPsec. # noqa: E501

Returns

The disable_event of this Ipsec. # noqa: E501

Return type

bool

property enabled

Gets the enabled of this Ipsec. # noqa: E501

Value is true if feature is enabled. Default value is true. Optional. # noqa: E501

Returns

The enabled of this Ipsec. # noqa: E501

Return type

bool

property feature_type

Gets the feature_type of this Ipsec. # noqa: E501

Returns

The feature_type of this Ipsec. # noqa: E501

Return type

str

property logging

Gets the logging of this Ipsec. # noqa: E501

Returns

The logging of this Ipsec. # noqa: E501

Return type

Logging

openapi_types = {'_global': 'IpsecGlobalConfig', 'disable_event': 'bool', 'enabled': 'bool', 'feature_type': 'str', 'logging': 'Logging', 'sites': 'IpsecSites', 'template': 'str', 'version': 'int'}
property sites

Gets the sites of this Ipsec. # noqa: E501

Returns

The sites of this Ipsec. # noqa: E501

Return type

IpsecSites

property template

Gets the template of this Ipsec. # noqa: E501

Returns

The template of this Ipsec. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this Ipsec. # noqa: E501

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. # noqa: E501

Returns

The version of this Ipsec. # noqa: E501

Return type

int

vmware.vmc.console.models.ipsec_dashboard_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ipsec_dashboard_stats.IpsecDashboardStats(ipsec_bytes_out=None, ipsec_bytes_in=None, ipsec_tunnels=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

IpsecDashboardStats - a model defined in OpenAPI

attribute_map = {'ipsec_bytes_in': 'ipsecBytesIn', 'ipsec_bytes_out': 'ipsecBytesOut', 'ipsec_tunnels': 'ipsecTunnels'}
property ipsec_bytes_in

Gets the ipsec_bytes_in of this IpsecDashboardStats. # noqa: E501

Rx received bytes. # noqa: E501

Returns

The ipsec_bytes_in of this IpsecDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property ipsec_bytes_out

Gets the ipsec_bytes_out of this IpsecDashboardStats. # noqa: E501

Tx transmitted bytes. # noqa: E501

Returns

The ipsec_bytes_out of this IpsecDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property ipsec_tunnels

Gets the ipsec_tunnels of this IpsecDashboardStats. # noqa: E501

Number of Ipsec tunnels. # noqa: E501

Returns

The ipsec_tunnels of this IpsecDashboardStats. # noqa: E501

Return type

list[DashboardStat]

openapi_types = {'ipsec_bytes_in': 'list[DashboardStat]', 'ipsec_bytes_out': 'list[DashboardStat]', 'ipsec_tunnels': 'list[DashboardStat]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.ipsec_global_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ipsec_global_config.IpsecGlobalConfig(psk=None, ca_certificates=None, service_certificate=None, crl_certificates=None, extension=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

IpsecGlobalConfig - a model defined in OpenAPI

attribute_map = {'ca_certificates': 'caCertificates', 'crl_certificates': 'crlCertificates', 'extension': 'extension', 'psk': 'psk', 'service_certificate': 'serviceCertificate'}
property ca_certificates

Gets the ca_certificates of this IpsecGlobalConfig. # noqa: E501

Returns

The ca_certificates of this IpsecGlobalConfig. # noqa: E501

Return type

CaCertificates

property crl_certificates

Gets the crl_certificates of this IpsecGlobalConfig. # noqa: E501

Returns

The crl_certificates of this IpsecGlobalConfig. # noqa: E501

Return type

CrlCertificates

property extension

Gets the extension of this IpsecGlobalConfig. # noqa: E501

Returns

The extension of this IpsecGlobalConfig. # noqa: E501

Return type

str

openapi_types = {'ca_certificates': 'CaCertificates', 'crl_certificates': 'CrlCertificates', 'extension': 'str', 'psk': 'str', 'service_certificate': 'str'}
property psk

Gets the psk of this IpsecGlobalConfig. # noqa: E501

IPsec Global Pre Shared Key. Maximum characters is 128. Required when peerIp is configured as ‘any’ in NSX Edge IPsec Site configuration. # noqa: E501

Returns

The psk of this IpsecGlobalConfig. # noqa: E501

Return type

str

property service_certificate

Gets the service_certificate of this IpsecGlobalConfig. # noqa: E501

Certificate name or identifier. Required when x.509 is selected as the authentication mode. # noqa: E501

Returns

The service_certificate of this IpsecGlobalConfig. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.ipsec_site module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ipsec_site.IpsecSite(psk=None, local_id=None, enable_pfs=None, authentication_mode=None, peer_subnets=None, dh_group=None, site_id=None, description=None, peer_ip=None, name=None, certificate=None, local_ip=None, encryption_algorithm=None, enabled=None, mtu=None, extension=None, peer_id=None, local_subnets=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

IpsecSite - a model defined in OpenAPI

attribute_map = {'authentication_mode': 'authenticationMode', 'certificate': 'certificate', 'description': 'description', 'dh_group': 'dhGroup', 'enable_pfs': 'enablePfs', 'enabled': 'enabled', 'encryption_algorithm': 'encryptionAlgorithm', 'extension': 'extension', 'local_id': 'localId', 'local_ip': 'localIp', 'local_subnets': 'localSubnets', 'mtu': 'mtu', 'name': 'name', 'peer_id': 'peerId', 'peer_ip': 'peerIp', 'peer_subnets': 'peerSubnets', 'psk': 'psk', 'site_id': 'siteId'}
property authentication_mode

Gets the authentication_mode of this IpsecSite. # noqa: E501

Authentication mode for the IPsec Site. Valid values are psk and x.509, with psk as default. # noqa: E501

Returns

The authentication_mode of this IpsecSite. # noqa: E501

Return type

str

property certificate

Gets the certificate of this IpsecSite. # noqa: E501

Returns

The certificate of this IpsecSite. # noqa: E501

Return type

str

property description

Gets the description of this IpsecSite. # noqa: E501

Description of the IPsec Site. # noqa: E501

Returns

The description of this IpsecSite. # noqa: E501

Return type

str

property dh_group

Gets the dh_group of this IpsecSite. # noqa: E501

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. # noqa: E501

Returns

The dh_group of this IpsecSite. # noqa: E501

Return type

str

property enable_pfs

Gets the enable_pfs of this IpsecSite. # noqa: E501

Enable/disable Perfect Forward Secrecy. Default is true. # noqa: E501

Returns

The enable_pfs of this IpsecSite. # noqa: E501

Return type

bool

property enabled

Gets the enabled of this IpsecSite. # noqa: E501

Enable/disable IPsec Site. # noqa: E501

Returns

The enabled of this IpsecSite. # noqa: E501

Return type

bool

property encryption_algorithm

Gets the encryption_algorithm of this IpsecSite. # noqa: E501

IPsec encryption algorithm with default as aes256. Valid values are ‘aes’, ‘aes256’, ‘3des’, ‘aes-gcm’. # noqa: E501

Returns

The encryption_algorithm of this IpsecSite. # noqa: E501

Return type

str

property extension

Gets the extension of this IpsecSite. # noqa: E501

Returns

The extension of this IpsecSite. # noqa: E501

Return type

str

property local_id

Gets the local_id of this IpsecSite. # noqa: E501

Local ID of the IPsec Site. Defaults to the local IP. # noqa: E501

Returns

The local_id of this IpsecSite. # noqa: E501

Return type

str

property local_ip

Gets the local_ip of this IpsecSite. # noqa: E501

Local IP of the IPsec Site. Should be one of the IP addresses configured on the uplink interfaces of the NSX Edge. Required. # noqa: E501

Returns

The local_ip of this IpsecSite. # noqa: E501

Return type

str

property local_subnets

Gets the local_subnets of this IpsecSite. # noqa: E501

Returns

The local_subnets of this IpsecSite. # noqa: E501

Return type

Subnets

property mtu

Gets the mtu of this IpsecSite. # noqa: E501

MTU for the IPsec site. Defaults to the mtu of the NSX Edge vnic specified by the localIp. Optional. # noqa: E501

Returns

The mtu of this IpsecSite. # noqa: E501

Return type

int

property name

Gets the name of this IpsecSite. # noqa: E501

Name of the IPsec Site. # noqa: E501

Returns

The name of this IpsecSite. # noqa: E501

Return type

str

openapi_types = {'authentication_mode': 'str', 'certificate': 'str', 'description': 'str', 'dh_group': 'str', 'enable_pfs': 'bool', 'enabled': 'bool', 'encryption_algorithm': 'str', 'extension': 'str', 'local_id': 'str', 'local_ip': 'str', 'local_subnets': 'Subnets', 'mtu': 'int', 'name': 'str', 'peer_id': 'str', 'peer_ip': 'str', 'peer_subnets': 'Subnets', 'psk': 'str', 'site_id': 'str'}
property peer_id

Gets the peer_id of this IpsecSite. # noqa: E501

Peer ID. Should be unique for all IPsec Site’s configured for an NSX Edge. # noqa: E501

Returns

The peer_id of this IpsecSite. # noqa: E501

Return type

str

property peer_ip

Gets the peer_ip of this IpsecSite. # noqa: E501

IP (IPv4) address or FQDN of the Peer. Can also be specified as ‘any’. Required. # noqa: E501

Returns

The peer_ip of this IpsecSite. # noqa: E501

Return type

str

property peer_subnets

Gets the peer_subnets of this IpsecSite. # noqa: E501

Returns

The peer_subnets of this IpsecSite. # noqa: E501

Return type

Subnets

property psk

Gets the psk of this IpsecSite. # noqa: E501

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’. # noqa: E501

Returns

The psk of this IpsecSite. # noqa: E501

Return type

str

property site_id

Gets the site_id of this IpsecSite. # noqa: E501

ID of the IPsec Site configuration provided by NSX Manager. # noqa: E501

Returns

The site_id of this IpsecSite. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.ipsec_site_ike_status module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ipsec_site_ike_status.IpsecSiteIKEStatus(channel_status=None, channel_state=None, peer_ip_address=None, local_ip_address=None, peer_subnets=None, peer_id=None, last_informational_message=None, local_subnets=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

IpsecSiteIKEStatus - a model defined in OpenAPI

attribute_map = {'channel_state': 'channelState', 'channel_status': 'channelStatus', 'last_informational_message': 'lastInformationalMessage', 'local_ip_address': 'localIpAddress', 'local_subnets': 'localSubnets', 'peer_id': 'peerId', 'peer_ip_address': 'peerIpAddress', 'peer_subnets': 'peerSubnets'}
property channel_state

Gets the channel_state of this IpsecSiteIKEStatus. # noqa: E501

Returns

The channel_state of this IpsecSiteIKEStatus. # noqa: E501

Return type

str

property channel_status

Gets the channel_status of this IpsecSiteIKEStatus. # noqa: E501

Returns

The channel_status of this IpsecSiteIKEStatus. # noqa: E501

Return type

str

property last_informational_message

Gets the last_informational_message of this IpsecSiteIKEStatus. # noqa: E501

Returns

The last_informational_message of this IpsecSiteIKEStatus. # noqa: E501

Return type

str

property local_ip_address

Gets the local_ip_address of this IpsecSiteIKEStatus. # noqa: E501

Returns

The local_ip_address of this IpsecSiteIKEStatus. # noqa: E501

Return type

str

property local_subnets

Gets the local_subnets of this IpsecSiteIKEStatus. # noqa: E501

Returns

The local_subnets of this IpsecSiteIKEStatus. # noqa: E501

Return type

list[str]

openapi_types = {'channel_state': 'str', 'channel_status': 'str', 'last_informational_message': 'str', 'local_ip_address': 'str', 'local_subnets': 'list[str]', 'peer_id': 'str', 'peer_ip_address': 'str', 'peer_subnets': 'list[str]'}
property peer_id

Gets the peer_id of this IpsecSiteIKEStatus. # noqa: E501

Returns

The peer_id of this IpsecSiteIKEStatus. # noqa: E501

Return type

str

property peer_ip_address

Gets the peer_ip_address of this IpsecSiteIKEStatus. # noqa: E501

Returns

The peer_ip_address of this IpsecSiteIKEStatus. # noqa: E501

Return type

str

property peer_subnets

Gets the peer_subnets of this IpsecSiteIKEStatus. # noqa: E501

Returns

The peer_subnets of this IpsecSiteIKEStatus. # noqa: E501

Return type

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.ipsec_site_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ipsec_site_stats.IpsecSiteStats(rx_bytes_on_site=None, tunnel_stats=None, ike_status=None, site_status=None, tx_bytes_from_site=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

IpsecSiteStats - a model defined in OpenAPI

attribute_map = {'ike_status': 'ikeStatus', 'rx_bytes_on_site': 'rxBytesOnSite', 'site_status': 'siteStatus', 'tunnel_stats': 'tunnelStats', 'tx_bytes_from_site': 'txBytesFromSite'}
property ike_status

Gets the ike_status of this IpsecSiteStats. # noqa: E501

Returns

The ike_status of this IpsecSiteStats. # noqa: E501

Return type

IpsecSiteIKEStatus

openapi_types = {'ike_status': 'IpsecSiteIKEStatus', 'rx_bytes_on_site': 'int', 'site_status': 'str', 'tunnel_stats': 'list[IpsecTunnelStats]', 'tx_bytes_from_site': 'int'}
property rx_bytes_on_site

Gets the rx_bytes_on_site of this IpsecSiteStats. # noqa: E501

Returns

The rx_bytes_on_site of this IpsecSiteStats. # noqa: E501

Return type

int

property site_status

Gets the site_status of this IpsecSiteStats. # noqa: E501

Returns

The site_status of this IpsecSiteStats. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tunnel_stats

Gets the tunnel_stats of this IpsecSiteStats. # noqa: E501

Returns

The tunnel_stats of this IpsecSiteStats. # noqa: E501

Return type

list[IpsecTunnelStats]

property tx_bytes_from_site

Gets the tx_bytes_from_site of this IpsecSiteStats. # noqa: E501

Returns

The tx_bytes_from_site of this IpsecSiteStats. # noqa: E501

Return type

int

vmware.vmc.console.models.ipsec_sites module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ipsec_sites.IpsecSites(sites=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

IpsecSites - a model defined in OpenAPI

attribute_map = {'sites': 'sites'}
openapi_types = {'sites': 'list[IpsecSite]'}
property sites

Gets the sites of this IpsecSites. # noqa: E501

Returns

The sites of this IpsecSites. # noqa: E501

Return type

list[IpsecSite]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.ipsec_status_and_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ipsec_status_and_stats.IpsecStatusAndStats(time_stamp=None, server_status=None, site_statistics=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

IpsecStatusAndStats - a model defined in OpenAPI

attribute_map = {'server_status': 'serverStatus', 'site_statistics': 'siteStatistics', 'time_stamp': 'timeStamp'}
openapi_types = {'server_status': 'str', 'site_statistics': 'list[IpsecSiteStats]', 'time_stamp': 'int'}
property server_status

Gets the server_status of this IpsecStatusAndStats. # noqa: E501

Returns

The server_status of this IpsecStatusAndStats. # noqa: E501

Return type

str

property site_statistics

Gets the site_statistics of this IpsecStatusAndStats. # noqa: E501

Returns

The site_statistics of this IpsecStatusAndStats. # noqa: E501

Return type

list[IpsecSiteStats]

property time_stamp

Gets the time_stamp of this IpsecStatusAndStats. # noqa: E501

Returns

The time_stamp of this IpsecStatusAndStats. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.ipsec_tunnel_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.ipsec_tunnel_stats.IpsecTunnelStats(tunnel_status=None, peer_spi=None, rx_bytes_on_local_subnet=None, established_date=None, peer_subnet=None, authentication_algorithm=None, tunnel_state=None, tx_bytes_from_local_subnet=None, last_informational_message=None, local_spi=None, encryption_algorithm=None, local_subnet=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

IpsecTunnelStats - a model defined in OpenAPI

attribute_map = {'authentication_algorithm': 'authenticationAlgorithm', 'encryption_algorithm': 'encryptionAlgorithm', 'established_date': 'establishedDate', 'last_informational_message': 'lastInformationalMessage', 'local_spi': 'localSPI', 'local_subnet': 'localSubnet', 'peer_spi': 'peerSPI', 'peer_subnet': 'peerSubnet', 'rx_bytes_on_local_subnet': 'rxBytesOnLocalSubnet', 'tunnel_state': 'tunnelState', 'tunnel_status': 'tunnelStatus', 'tx_bytes_from_local_subnet': 'txBytesFromLocalSubnet'}
property authentication_algorithm

Gets the authentication_algorithm of this IpsecTunnelStats. # noqa: E501

Returns

The authentication_algorithm of this IpsecTunnelStats. # noqa: E501

Return type

str

property encryption_algorithm

Gets the encryption_algorithm of this IpsecTunnelStats. # noqa: E501

Returns

The encryption_algorithm of this IpsecTunnelStats. # noqa: E501

Return type

str

property established_date

Gets the established_date of this IpsecTunnelStats. # noqa: E501

Returns

The established_date of this IpsecTunnelStats. # noqa: E501

Return type

str

property last_informational_message

Gets the last_informational_message of this IpsecTunnelStats. # noqa: E501

Returns

The last_informational_message of this IpsecTunnelStats. # noqa: E501

Return type

str

property local_spi

Gets the local_spi of this IpsecTunnelStats. # noqa: E501

Returns

The local_spi of this IpsecTunnelStats. # noqa: E501

Return type

str

property local_subnet

Gets the local_subnet of this IpsecTunnelStats. # noqa: E501

Returns

The local_subnet of this IpsecTunnelStats. # noqa: E501

Return type

str

openapi_types = {'authentication_algorithm': 'str', 'encryption_algorithm': 'str', 'established_date': 'str', 'last_informational_message': 'str', 'local_spi': 'str', 'local_subnet': 'str', 'peer_spi': 'str', 'peer_subnet': 'str', 'rx_bytes_on_local_subnet': 'int', 'tunnel_state': 'str', 'tunnel_status': 'str', 'tx_bytes_from_local_subnet': 'int'}
property peer_spi

Gets the peer_spi of this IpsecTunnelStats. # noqa: E501

Returns

The peer_spi of this IpsecTunnelStats. # noqa: E501

Return type

str

property peer_subnet

Gets the peer_subnet of this IpsecTunnelStats. # noqa: E501

Returns

The peer_subnet of this IpsecTunnelStats. # noqa: E501

Return type

str

property rx_bytes_on_local_subnet

Gets the rx_bytes_on_local_subnet of this IpsecTunnelStats. # noqa: E501

Returns

The rx_bytes_on_local_subnet of this IpsecTunnelStats. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tunnel_state

Gets the tunnel_state of this IpsecTunnelStats. # noqa: E501

Returns

The tunnel_state of this IpsecTunnelStats. # noqa: E501

Return type

str

property tunnel_status

Gets the tunnel_status of this IpsecTunnelStats. # noqa: E501

Returns

The tunnel_status of this IpsecTunnelStats. # noqa: E501

Return type

str

property tx_bytes_from_local_subnet

Gets the tx_bytes_from_local_subnet of this IpsecTunnelStats. # noqa: E501

Returns

The tx_bytes_from_local_subnet of this IpsecTunnelStats. # noqa: E501

Return type

int

vmware.vmc.console.models.key_value_attributes module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.key_value_attributes.KeyValueAttributes(value=None, key=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

KeyValueAttributes - a model defined in OpenAPI

attribute_map = {'key': 'key', 'value': 'value'}
property key

Gets the key of this KeyValueAttributes. # noqa: E501

Key name of the configuration limit parameter. # noqa: E501

Returns

The key of this KeyValueAttributes. # noqa: E501

Return type

str

openapi_types = {'key': 'str', 'value': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this KeyValueAttributes. # noqa: E501

Value corresponding to the key of the configuration limit parameter. # noqa: E501

Returns

The value of this KeyValueAttributes. # noqa: E501

Return type

str

vmware.vmc.console.models.kms_vpc_endpoint module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.kms_vpc_endpoint.KmsVpcEndpoint(vpc_endpoint_id=None, network_interface_ids=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

KmsVpcEndpoint - a model defined in OpenAPI

attribute_map = {'network_interface_ids': 'network_interface_ids', 'vpc_endpoint_id': 'vpc_endpoint_id'}
property network_interface_ids

Gets the network_interface_ids of this KmsVpcEndpoint. # noqa: E501

Returns

The network_interface_ids of this KmsVpcEndpoint. # noqa: E501

Return type

list[str]

openapi_types = {'network_interface_ids': 'list[str]', 'vpc_endpoint_id': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpc_endpoint_id

Gets the vpc_endpoint_id of this KmsVpcEndpoint. # noqa: E501

The identifier of the VPC endpoint created to AWS Key Management Service # noqa: E501

Returns

The vpc_endpoint_id of this KmsVpcEndpoint. # noqa: E501

Return type

str

vmware.vmc.console.models.l2_extension module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.l2_extension.L2Extension(tunnel_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

L2Extension - a model defined in OpenAPI

attribute_map = {'tunnel_id': 'tunnelId'}
openapi_types = {'tunnel_id': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tunnel_id

Gets the tunnel_id of this L2Extension. # noqa: E501

Identifier for layer 2 extension tunnel. Valid range: 1-4093. # noqa: E501

Returns

The tunnel_id of this L2Extension. # noqa: E501

Return type

int

vmware.vmc.console.models.l2_vpn module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.l2_vpn.L2Vpn(enabled=None, sites=None, listener_ip=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

L2Vpn - a model defined in OpenAPI

attribute_map = {'enabled': 'enabled', 'listener_ip': 'listener_ip', 'sites': 'sites'}
property enabled

Gets the enabled of this L2Vpn. # noqa: E501

Enable (true) or disable (false) L2 VPN. # noqa: E501

Returns

The enabled of this L2Vpn. # noqa: E501

Return type

bool

property listener_ip

Gets the listener_ip of this L2Vpn. # noqa: E501

Public uplink ip address. IP of external interface on which L2VPN service listens to. # noqa: E501

Returns

The listener_ip of this L2Vpn. # noqa: E501

Return type

str

openapi_types = {'enabled': 'bool', 'listener_ip': 'str', 'sites': 'list[Site]'}
property sites

Gets the sites of this L2Vpn. # noqa: E501

Array of L2 vpn site config. # noqa: E501

Returns

The sites of this L2Vpn. # noqa: E501

Return type

list[Site]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.l2vpn_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.l2vpn_stats.L2vpnStats(tunnel_status=None, established_date=None, name=None, dropped_rx_packets=None, encryption_algorithm=None, failure_message=None, tx_bytes_from_local_subnet=None, rx_bytes_on_local_subnet=None, dropped_tx_packets=None, last_updated_time=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

L2vpnStats - a model defined in OpenAPI

attribute_map = {'dropped_rx_packets': 'droppedRxPackets', 'dropped_tx_packets': 'droppedTxPackets', 'encryption_algorithm': 'encryptionAlgorithm', 'established_date': 'establishedDate', 'failure_message': 'failureMessage', 'last_updated_time': 'lastUpdatedTime', 'name': 'name', 'rx_bytes_on_local_subnet': 'rxBytesOnLocalSubnet', 'tunnel_status': 'tunnelStatus', 'tx_bytes_from_local_subnet': 'txBytesFromLocalSubnet'}
property dropped_rx_packets

Gets the dropped_rx_packets of this L2vpnStats. # noqa: E501

Number of received packets dropped. # noqa: E501

Returns

The dropped_rx_packets of this L2vpnStats. # noqa: E501

Return type

int

property dropped_tx_packets

Gets the dropped_tx_packets of this L2vpnStats. # noqa: E501

Number of transferred packets dropped. # noqa: E501

Returns

The dropped_tx_packets of this L2vpnStats. # noqa: E501

Return type

int

property encryption_algorithm

Gets the encryption_algorithm of this L2vpnStats. # noqa: E501

Cipher used in encryption. # noqa: E501

Returns

The encryption_algorithm of this L2vpnStats. # noqa: E501

Return type

str

property established_date

Gets the established_date of this L2vpnStats. # noqa: E501

Tunnel established date. # noqa: E501

Returns

The established_date of this L2vpnStats. # noqa: E501

Return type

int

property failure_message

Gets the failure_message of this L2vpnStats. # noqa: E501

Reason for the tunnel down. # noqa: E501

Returns

The failure_message of this L2vpnStats. # noqa: E501

Return type

str

property last_updated_time

Gets the last_updated_time of this L2vpnStats. # noqa: E501

Time stamp of the statistics collection. # noqa: E501

Returns

The last_updated_time of this L2vpnStats. # noqa: E501

Return type

int

property name

Gets the name of this L2vpnStats. # noqa: E501

User defined name of the site. # noqa: E501

Returns

The name of this L2vpnStats. # noqa: E501

Return type

str

openapi_types = {'dropped_rx_packets': 'int', 'dropped_tx_packets': 'int', 'encryption_algorithm': 'str', 'established_date': 'int', 'failure_message': 'str', 'last_updated_time': 'int', 'name': 'str', 'rx_bytes_on_local_subnet': 'int', 'tunnel_status': 'str', 'tx_bytes_from_local_subnet': 'int'}
property rx_bytes_on_local_subnet

Gets the rx_bytes_on_local_subnet of this L2vpnStats. # noqa: E501

Number of bytes received on the local subnet. # noqa: E501

Returns

The rx_bytes_on_local_subnet of this L2vpnStats. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tunnel_status

Gets the tunnel_status of this L2vpnStats. # noqa: E501

Status of the tunnel (UP/DOWN). # noqa: E501

Returns

The tunnel_status of this L2vpnStats. # noqa: E501

Return type

str

property tx_bytes_from_local_subnet

Gets the tx_bytes_from_local_subnet of this L2vpnStats. # noqa: E501

Number of bytes transferred from local subnet. # noqa: E501

Returns

The tx_bytes_from_local_subnet of this L2vpnStats. # noqa: E501

Return type

int

vmware.vmc.console.models.l2vpn_status_and_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.l2vpn_status_and_stats.L2vpnStatusAndStats(time_stamp=None, server_status=None, site_stats=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

L2vpnStatusAndStats - a model defined in OpenAPI

attribute_map = {'server_status': 'serverStatus', 'site_stats': 'siteStats', 'time_stamp': 'timeStamp'}
openapi_types = {'server_status': 'str', 'site_stats': 'list[L2vpnStats]', 'time_stamp': 'int'}
property server_status

Gets the server_status of this L2vpnStatusAndStats. # noqa: E501

Returns

The server_status of this L2vpnStatusAndStats. # noqa: E501

Return type

str

property site_stats

Gets the site_stats of this L2vpnStatusAndStats. # noqa: E501

List of statistics for each Site. # noqa: E501

Returns

The site_stats of this L2vpnStatusAndStats. # noqa: E501

Return type

list[L2vpnStats]

property time_stamp

Gets the time_stamp of this L2vpnStatusAndStats. # noqa: E501

Time stamp of statistics collection. # noqa: E501

Returns

The time_stamp of this L2vpnStatusAndStats. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.licence_acl_permissions module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.licence_acl_permissions.LicenceAclPermissions(data_permission=None, is_licensed=None, access_permission=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

LicenceAclPermissions - a model defined in OpenAPI

property access_permission

Gets the access_permission of this LicenceAclPermissions. # noqa: E501

Returns

The access_permission of this LicenceAclPermissions. # noqa: E501

Return type

InteractionPermissions

attribute_map = {'access_permission': 'accessPermission', 'data_permission': 'dataPermission', 'is_licensed': 'isLicensed'}
property data_permission

Gets the data_permission of this LicenceAclPermissions. # noqa: E501

Returns

The data_permission of this LicenceAclPermissions. # noqa: E501

Return type

DataPermissions

property is_licensed

Gets the is_licensed of this LicenceAclPermissions. # noqa: E501

Value is true if feature is licenced. # noqa: E501

Returns

The is_licensed of this LicenceAclPermissions. # noqa: E501

Return type

bool

openapi_types = {'access_permission': 'InteractionPermissions', 'data_permission': 'DataPermissions', 'is_licensed': 'bool'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.load_balancer_dashboard_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.load_balancer_dashboard_stats.LoadBalancerDashboardStats(lb_bps_in=None, lb_http_reqs=None, lb_bps_out=None, lb_sessions=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

LoadBalancerDashboardStats - a model defined in OpenAPI

attribute_map = {'lb_bps_in': 'lbBpsIn', 'lb_bps_out': 'lbBpsOut', 'lb_http_reqs': 'lbHttpReqs', 'lb_sessions': 'lbSessions'}
property lb_bps_in

Gets the lb_bps_in of this LoadBalancerDashboardStats. # noqa: E501

Number of bytes in. # noqa: E501

Returns

The lb_bps_in of this LoadBalancerDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property lb_bps_out

Gets the lb_bps_out of this LoadBalancerDashboardStats. # noqa: E501

Number of bytes out. # noqa: E501

Returns

The lb_bps_out of this LoadBalancerDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property lb_http_reqs

Gets the lb_http_reqs of this LoadBalancerDashboardStats. # noqa: E501

Number of HTTP requests received by Load Balancer. # noqa: E501

Returns

The lb_http_reqs of this LoadBalancerDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property lb_sessions

Gets the lb_sessions of this LoadBalancerDashboardStats. # noqa: E501

Number of Load Balancer sessions. # noqa: E501

Returns

The lb_sessions of this LoadBalancerDashboardStats. # noqa: E501

Return type

list[DashboardStat]

openapi_types = {'lb_bps_in': 'list[DashboardStat]', 'lb_bps_out': 'list[DashboardStat]', 'lb_http_reqs': 'list[DashboardStat]', 'lb_sessions': 'list[DashboardStat]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.logging module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.logging.Logging(log_level=None, enable=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Logging - a model defined in OpenAPI

attribute_map = {'enable': 'enable', 'log_level': 'logLevel'}
property enable

Gets the enable of this Logging. # noqa: E501

Logging enabled. # noqa: E501

Returns

The enable of this Logging. # noqa: E501

Return type

bool

property log_level

Gets the log_level of this Logging. # noqa: E501

Log level. Valid values: emergency, alert, critical, error, warning, notice, info, debug. # noqa: E501

Returns

The log_level of this Logging. # noqa: E501

Return type

str

openapi_types = {'enable': 'bool', 'log_level': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.logical_network module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.logical_network.LogicalNetwork(subnet_cidr=None, name=None, gateway_ip=None, dhcp_enabled=None, dhcp_ip_range=None, tunnel_id=None, id=None, network_type=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

LogicalNetwork - a model defined in OpenAPI

attribute_map = {'dhcp_enabled': 'dhcp_enabled', 'dhcp_ip_range': 'dhcp_ip_range', 'gateway_ip': 'gatewayIp', 'id': 'id', 'name': 'name', 'network_type': 'network_type', 'subnet_cidr': 'subnet_cidr', 'tunnel_id': 'tunnel_id'}
property dhcp_enabled

Gets the dhcp_enabled of this LogicalNetwork. # noqa: E501

if ‘true’ - enabled; if ‘false’ - disabled # noqa: E501

Returns

The dhcp_enabled of this LogicalNetwork. # noqa: E501

Return type

str

property dhcp_ip_range

Gets the dhcp_ip_range of this LogicalNetwork. # noqa: E501

ip range within the subnet mask, range delimiter is ‘-‘ (example 10.118.10.130-10.118.10.140) # noqa: E501

Returns

The dhcp_ip_range of this LogicalNetwork. # noqa: E501

Return type

str

property gateway_ip

Gets the gateway_ip of this LogicalNetwork. # noqa: E501

gateway ip of the logical network # noqa: E501

Returns

The gateway_ip of this LogicalNetwork. # noqa: E501

Return type

str

property id

Gets the id of this LogicalNetwork. # noqa: E501

Returns

The id of this LogicalNetwork. # noqa: E501

Return type

str

property name

Gets the name of this LogicalNetwork. # noqa: E501

name of the network # noqa: E501

Returns

The name of this LogicalNetwork. # noqa: E501

Return type

str

property network_type

Gets the network_type of this LogicalNetwork. # noqa: E501

Returns

The network_type of this LogicalNetwork. # noqa: E501

Return type

str

openapi_types = {'dhcp_enabled': 'str', 'dhcp_ip_range': 'str', 'gateway_ip': 'str', 'id': 'str', 'name': 'str', 'network_type': 'str', 'subnet_cidr': 'str', 'tunnel_id': 'int'}
property subnet_cidr

Gets the subnet_cidr of this LogicalNetwork. # noqa: E501

the subnet cidr # noqa: E501

Returns

The subnet_cidr of this LogicalNetwork. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tunnel_id

Gets the tunnel_id of this LogicalNetwork. # noqa: E501

tunnel id of extended network # noqa: E501

Returns

The tunnel_id of this LogicalNetwork. # noqa: E501

Return type

int

vmware.vmc.console.models.logical_router_scope module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.logical_router_scope.LogicalRouterScope(type=None, id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

LogicalRouterScope - a model defined in OpenAPI

attribute_map = {'id': 'id', 'type': 'type'}
property id

Gets the id of this LogicalRouterScope. # noqa: E501

Returns

The id of this LogicalRouterScope. # noqa: E501

Return type

str

openapi_types = {'id': 'str', 'type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this LogicalRouterScope. # noqa: E501

Returns

The type of this LogicalRouterScope. # noqa: E501

Return type

str

vmware.vmc.console.models.logical_router_scopes module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.logical_router_scopes.LogicalRouterScopes(logical_router_scope=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

LogicalRouterScopes - a model defined in OpenAPI

attribute_map = {'logical_router_scope': 'logicalRouterScope'}
property logical_router_scope

Gets the logical_router_scope of this LogicalRouterScopes. # noqa: E501

Returns

The logical_router_scope of this LogicalRouterScopes. # noqa: E501

Return type

list[LogicalRouterScope]

openapi_types = {'logical_router_scope': 'list[LogicalRouterScope]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.mac_address module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.mac_address.MacAddress(edge_vm_ha_index=None, value=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

MacAddress - a model defined in OpenAPI

attribute_map = {'edge_vm_ha_index': 'edgeVmHaIndex', 'value': 'value'}
property edge_vm_ha_index

Gets the edge_vm_ha_index of this MacAddress. # noqa: E501

Returns

The edge_vm_ha_index of this MacAddress. # noqa: E501

Return type

int

openapi_types = {'edge_vm_ha_index': 'int', 'value': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this MacAddress. # noqa: E501

Returns

The value of this MacAddress. # noqa: E501

Return type

str

vmware.vmc.console.models.maintenance_window module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.maintenance_window.MaintenanceWindow(day_of_week=None, hour_of_day=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

MaintenanceWindow - a model defined in OpenAPI

attribute_map = {'day_of_week': 'day_of_week', 'hour_of_day': 'hour_of_day'}
property day_of_week

Gets the day_of_week of this MaintenanceWindow. # noqa: E501

Returns

The day_of_week of this MaintenanceWindow. # noqa: E501

Return type

str

property hour_of_day

Gets the hour_of_day of this MaintenanceWindow. # noqa: E501

Returns

The hour_of_day of this MaintenanceWindow. # noqa: E501

Return type

int

openapi_types = {'day_of_week': 'str', 'hour_of_day': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.maintenance_window_entry module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.maintenance_window_entry.MaintenanceWindowEntry(in_maintenance_window=None, reservation_schedule=None, reservation_id=None, in_maintenance_mode=None, sddc_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

MaintenanceWindowEntry - a model defined in OpenAPI

attribute_map = {'in_maintenance_mode': 'in_maintenance_mode', 'in_maintenance_window': 'in_maintenance_window', 'reservation_id': 'reservation_id', 'reservation_schedule': 'reservation_schedule', 'sddc_id': 'sddc_id'}
property in_maintenance_mode

Gets the in_maintenance_mode of this MaintenanceWindowEntry. # noqa: E501

true if the SDDC is currently undergoing maintenance # noqa: E501

Returns

The in_maintenance_mode of this MaintenanceWindowEntry. # noqa: E501

Return type

bool

property in_maintenance_window

Gets the in_maintenance_window of this MaintenanceWindowEntry. # noqa: E501

true if the SDDC is in the defined Mainentance Window # noqa: E501

Returns

The in_maintenance_window of this MaintenanceWindowEntry. # noqa: E501

Return type

bool

openapi_types = {'in_maintenance_mode': 'bool', 'in_maintenance_window': 'bool', 'reservation_id': 'str', 'reservation_schedule': 'ReservationSchedule', 'sddc_id': 'str'}
property reservation_id

Gets the reservation_id of this MaintenanceWindowEntry. # noqa: E501

ID for reservation # noqa: E501

Returns

The reservation_id of this MaintenanceWindowEntry. # noqa: E501

Return type

str

property reservation_schedule

Gets the reservation_schedule of this MaintenanceWindowEntry. # noqa: E501

Returns

The reservation_schedule of this MaintenanceWindowEntry. # noqa: E501

Return type

ReservationSchedule

property sddc_id

Gets the sddc_id of this MaintenanceWindowEntry. # noqa: E501

SDDC ID for this reservation # noqa: E501

Returns

The sddc_id of this MaintenanceWindowEntry. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.maintenance_window_get module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.maintenance_window_get.MaintenanceWindowGet(day_of_week=None, hour_of_day=None, duration_min=None, version=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

MaintenanceWindowGet - a model defined in OpenAPI

attribute_map = {'day_of_week': 'day_of_week', 'duration_min': 'duration_min', 'hour_of_day': 'hour_of_day', 'version': 'version'}
property day_of_week

Gets the day_of_week of this MaintenanceWindowGet. # noqa: E501

Returns

The day_of_week of this MaintenanceWindowGet. # noqa: E501

Return type

str

property duration_min

Gets the duration_min of this MaintenanceWindowGet. # noqa: E501

Returns

The duration_min of this MaintenanceWindowGet. # noqa: E501

Return type

int

property hour_of_day

Gets the hour_of_day of this MaintenanceWindowGet. # noqa: E501

Returns

The hour_of_day of this MaintenanceWindowGet. # noqa: E501

Return type

int

openapi_types = {'day_of_week': 'str', 'duration_min': 'int', 'hour_of_day': 'int', 'version': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this MaintenanceWindowGet. # noqa: E501

Returns

The version of this MaintenanceWindowGet. # noqa: E501

Return type

int

vmware.vmc.console.models.maintenance_window_get_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.maintenance_window_get_all_of.MaintenanceWindowGetAllOf(duration_min=None, version=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

MaintenanceWindowGetAllOf - a model defined in OpenAPI

attribute_map = {'duration_min': 'duration_min', 'version': 'version'}
property duration_min

Gets the duration_min of this MaintenanceWindowGetAllOf. # noqa: E501

Returns

The duration_min of this MaintenanceWindowGetAllOf. # noqa: E501

Return type

int

openapi_types = {'duration_min': 'int', 'version': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this MaintenanceWindowGetAllOf. # noqa: E501

Returns

The version of this MaintenanceWindowGetAllOf. # noqa: E501

Return type

int

vmware.vmc.console.models.management_gateway_template module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.management_gateway_template.ManagementGatewayTemplate(public_ip=None, primary_dns=None, secondary_dns=None, firewall_rules=None, vpns=None, subnet_cidr=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ManagementGatewayTemplate - a model defined in OpenAPI

attribute_map = {'firewall_rules': 'firewall_rules', 'primary_dns': 'primary_dns', 'public_ip': 'public_ip', 'secondary_dns': 'secondary_dns', 'subnet_cidr': 'subnet_cidr', 'vpns': 'vpns'}
property firewall_rules

Gets the firewall_rules of this ManagementGatewayTemplate. # noqa: E501

Returns

The firewall_rules of this ManagementGatewayTemplate. # noqa: E501

Return type

list[FirewallRule]

openapi_types = {'firewall_rules': 'list[FirewallRule]', 'primary_dns': 'str', 'public_ip': 'SddcPublicIp', 'secondary_dns': 'str', 'subnet_cidr': 'str', 'vpns': 'list[Vpn]'}
property primary_dns

Gets the primary_dns of this ManagementGatewayTemplate. # noqa: E501

Returns

The primary_dns of this ManagementGatewayTemplate. # noqa: E501

Return type

str

property public_ip

Gets the public_ip of this ManagementGatewayTemplate. # noqa: E501

Returns

The public_ip of this ManagementGatewayTemplate. # noqa: E501

Return type

SddcPublicIp

property secondary_dns

Gets the secondary_dns of this ManagementGatewayTemplate. # noqa: E501

Returns

The secondary_dns of this ManagementGatewayTemplate. # noqa: E501

Return type

str

property subnet_cidr

Gets the subnet_cidr of this ManagementGatewayTemplate. # noqa: E501

mgw network subnet cidr # noqa: E501

Returns

The subnet_cidr of this ManagementGatewayTemplate. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpns

Gets the vpns of this ManagementGatewayTemplate. # noqa: E501

Returns

The vpns of this ManagementGatewayTemplate. # noqa: E501

Return type

list[Vpn]

vmware.vmc.console.models.management_gateway_template_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.management_gateway_template_all_of.ManagementGatewayTemplateAllOf(subnet_cidr=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ManagementGatewayTemplateAllOf - a model defined in OpenAPI

attribute_map = {'subnet_cidr': 'subnet_cidr'}
openapi_types = {'subnet_cidr': 'str'}
property subnet_cidr

Gets the subnet_cidr of this ManagementGatewayTemplateAllOf. # noqa: E501

mgw network subnet cidr # noqa: E501

Returns

The subnet_cidr of this ManagementGatewayTemplateAllOf. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.map_zones_request module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.map_zones_request.MapZonesRequest(connected_account_id=None, org_id=None, petronas_regions_to_map=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

MapZonesRequest - a model defined in OpenAPI

attribute_map = {'connected_account_id': 'connected_account_id', 'org_id': 'org_id', 'petronas_regions_to_map': 'petronas_regions_to_map'}
property connected_account_id

Gets the connected_account_id of this MapZonesRequest. # noqa: E501

The connected account ID to remap. This is a standard UUID. # noqa: E501

Returns

The connected_account_id of this MapZonesRequest. # noqa: E501

Return type

str

openapi_types = {'connected_account_id': 'str', 'org_id': 'str', 'petronas_regions_to_map': 'list[str]'}
property org_id

Gets the org_id of this MapZonesRequest. # noqa: E501

The org ID to remap in. This is a standard UUID. # noqa: E501

Returns

The org_id of this MapZonesRequest. # noqa: E501

Return type

str

property petronas_regions_to_map

Gets the petronas_regions_to_map of this MapZonesRequest. # noqa: E501

A list of Petronas regions to map. # noqa: E501

Returns

The petronas_regions_to_map of this MapZonesRequest. # noqa: E501

Return type

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.meta_dashboard_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.meta_dashboard_stats.MetaDashboardStats(vnics=None, end_time=None, start_time=None, interval=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

MetaDashboardStats - a model defined in OpenAPI

attribute_map = {'end_time': 'endTime', 'interval': 'interval', 'start_time': 'startTime', 'vnics': 'vnics'}
property end_time

Gets the end_time of this MetaDashboardStats. # noqa: E501

End time in seconds. # noqa: E501

Returns

The end_time of this MetaDashboardStats. # noqa: E501

Return type

int

property interval

Gets the interval of this MetaDashboardStats. # noqa: E501

Time interval in seconds. # noqa: E501

Returns

The interval of this MetaDashboardStats. # noqa: E501

Return type

int

openapi_types = {'end_time': 'int', 'interval': 'int', 'start_time': 'int', 'vnics': 'list[Vnic]'}
property start_time

Gets the start_time of this MetaDashboardStats. # noqa: E501

Start time in seconds. # noqa: E501

Returns

The start_time of this MetaDashboardStats. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vnics

Gets the vnics of this MetaDashboardStats. # noqa: E501

Statistics data is collected for these vNICs. # noqa: E501

Returns

The vnics of this MetaDashboardStats. # noqa: E501

Return type

list[Vnic]

vmware.vmc.console.models.metadata module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.metadata.Metadata(timestamp=None, cycle_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Metadata - a model defined in OpenAPI

attribute_map = {'cycle_id': 'cycle_id', 'timestamp': 'timestamp'}
property cycle_id

Gets the cycle_id of this Metadata. # noqa: E501

the cycle id # noqa: E501

Returns

The cycle_id of this Metadata. # noqa: E501

Return type

str

openapi_types = {'cycle_id': 'str', 'timestamp': 'str'}
property timestamp

Gets the timestamp of this Metadata. # noqa: E501

the timestamp for the bundle # noqa: E501

Returns

The timestamp of this Metadata. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.msft_licensing_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.msft_licensing_config.MsftLicensingConfig(mssql_licensing=None, windows_licensing=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

MsftLicensingConfig - a model defined in OpenAPI

attribute_map = {'mssql_licensing': 'mssql_licensing', 'windows_licensing': 'windows_licensing'}
property mssql_licensing

Gets the mssql_licensing of this MsftLicensingConfig. # noqa: E501

The status MSSQL licensing for this SDDC’s clusters. # noqa: E501

Returns

The mssql_licensing of this MsftLicensingConfig. # noqa: E501

Return type

str

openapi_types = {'mssql_licensing': 'str', 'windows_licensing': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property windows_licensing

Gets the windows_licensing of this MsftLicensingConfig. # noqa: E501

The status of Windows licensing for this SDDC’s clusters. Can be enabled, disabled, or customer’s. # noqa: E501

Returns

The windows_licensing of this MsftLicensingConfig. # noqa: E501

Return type

str

vmware.vmc.console.models.nat module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.nat.Nat(rules=None, feature_type=None, version=None, enabled=None, template=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Nat - a model defined in OpenAPI

attribute_map = {'enabled': 'enabled', 'feature_type': 'featureType', 'rules': 'rules', 'template': 'template', 'version': 'version'}
property enabled

Gets the enabled of this Nat. # noqa: E501

Value is true if feature is enabled. Default value is true. Optional. # noqa: E501

Returns

The enabled of this Nat. # noqa: E501

Return type

bool

property feature_type

Gets the feature_type of this Nat. # noqa: E501

Returns

The feature_type of this Nat. # noqa: E501

Return type

str

openapi_types = {'enabled': 'bool', 'feature_type': 'str', 'rules': 'NatRules', 'template': 'str', 'version': 'int'}
property rules

Gets the rules of this Nat. # noqa: E501

Returns

The rules of this Nat. # noqa: E501

Return type

NatRules

property template

Gets the template of this Nat. # noqa: E501

Returns

The template of this Nat. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this Nat. # noqa: E501

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. # noqa: E501

Returns

The version of this Nat. # noqa: E501

Return type

int

vmware.vmc.console.models.nat_rule module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.nat_rule.NatRule(rule_type=None, protocol=None, name=None, internal_ports=None, public_ports=None, public_ip=None, internal_ip=None, action=None, id=None, revision=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

NatRule - a model defined in OpenAPI

property action

Gets the action of this NatRule. # noqa: E501

Returns

The action of this NatRule. # noqa: E501

Return type

str

attribute_map = {'action': 'action', 'id': 'id', 'internal_ip': 'internal_ip', 'internal_ports': 'internal_ports', 'name': 'name', 'protocol': 'protocol', 'public_ip': 'public_ip', 'public_ports': 'public_ports', 'revision': 'revision', 'rule_type': 'rule_type'}
property id

Gets the id of this NatRule. # noqa: E501

Returns

The id of this NatRule. # noqa: E501

Return type

str

property internal_ip

Gets the internal_ip of this NatRule. # noqa: E501

Returns

The internal_ip of this NatRule. # noqa: E501

Return type

str

property internal_ports

Gets the internal_ports of this NatRule. # noqa: E501

Returns

The internal_ports of this NatRule. # noqa: E501

Return type

str

property name

Gets the name of this NatRule. # noqa: E501

Returns

The name of this NatRule. # noqa: E501

Return type

str

openapi_types = {'action': 'str', 'id': 'str', 'internal_ip': 'str', 'internal_ports': 'str', 'name': 'str', 'protocol': 'str', 'public_ip': 'str', 'public_ports': 'str', 'revision': 'int', 'rule_type': 'str'}
property protocol

Gets the protocol of this NatRule. # noqa: E501

Returns

The protocol of this NatRule. # noqa: E501

Return type

str

property public_ip

Gets the public_ip of this NatRule. # noqa: E501

Returns

The public_ip of this NatRule. # noqa: E501

Return type

str

property public_ports

Gets the public_ports of this NatRule. # noqa: E501

Returns

The public_ports of this NatRule. # noqa: E501

Return type

str

property revision

Gets the revision of this NatRule. # noqa: E501

current revision of the list of nat rules, used to protect against concurrent modification (first writer wins) # noqa: E501

Returns

The revision of this NatRule. # noqa: E501

Return type

int

property rule_type

Gets the rule_type of this NatRule. # noqa: E501

Returns

The rule_type of this NatRule. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.nat_rules module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.nat_rules.NatRules(nat_rules_dtos=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

NatRules - a model defined in OpenAPI

attribute_map = {'nat_rules_dtos': 'natRulesDtos'}
property nat_rules_dtos

Gets the nat_rules_dtos of this NatRules. # noqa: E501

Ordered list of NAT rules. # noqa: E501

Returns

The nat_rules_dtos of this NatRules. # noqa: E501

Return type

list[Nsxnatrule]

openapi_types = {'nat_rules_dtos': 'list[Nsxnatrule]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.network_template module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.network_template.NetworkTemplate(management_gateway_templates=None, compute_gateway_templates=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

NetworkTemplate - a model defined in OpenAPI

attribute_map = {'compute_gateway_templates': 'compute_gateway_templates', 'management_gateway_templates': 'management_gateway_templates'}
property compute_gateway_templates

Gets the compute_gateway_templates of this NetworkTemplate. # noqa: E501

Returns

The compute_gateway_templates of this NetworkTemplate. # noqa: E501

Return type

list[ComputeGatewayTemplate]

property management_gateway_templates

Gets the management_gateway_templates of this NetworkTemplate. # noqa: E501

Returns

The management_gateway_templates of this NetworkTemplate. # noqa: E501

Return type

list[ManagementGatewayTemplate]

openapi_types = {'compute_gateway_templates': 'list[ComputeGatewayTemplate]', 'management_gateway_templates': 'list[ManagementGatewayTemplate]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.new_credentials module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.new_credentials.NewCredentials(username=None, password=None, name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

NewCredentials - a model defined in OpenAPI

attribute_map = {'name': 'name', 'password': 'password', 'username': 'username'}
property name

Gets the name of this NewCredentials. # noqa: E501

Name of the credentials # noqa: E501

Returns

The name of this NewCredentials. # noqa: E501

Return type

str

openapi_types = {'name': 'str', 'password': 'str', 'username': 'str'}
property password

Gets the password of this NewCredentials. # noqa: E501

Password associated with the credentials # noqa: E501

Returns

The password of this NewCredentials. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property username

Gets the username of this NewCredentials. # noqa: E501

Username of the credentials # noqa: E501

Returns

The username of this NewCredentials. # noqa: E501

Return type

str

vmware.vmc.console.models.nsxfirewallrule module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.nsxfirewallrule.Nsxfirewallrule(rule_type=None, description=None, rule_id=None, match_translated=None, invalid_application=None, direction=None, statistics=None, name=None, invalid_source=None, logging_enabled=None, destination=None, enabled=None, application=None, source=None, action=None, invalid_destination=None, rule_tag=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Nsxfirewallrule - a model defined in OpenAPI

property action

Gets the action of this Nsxfirewallrule. # noqa: E501

Action. Values : accept, deny # noqa: E501

Returns

The action of this Nsxfirewallrule. # noqa: E501

Return type

str

property application

Gets the application of this Nsxfirewallrule. # noqa: E501

Returns

The application of this Nsxfirewallrule. # noqa: E501

Return type

Application

attribute_map = {'action': 'action', 'application': 'application', 'description': 'description', 'destination': 'destination', 'direction': 'direction', 'enabled': 'enabled', 'invalid_application': 'invalidApplication', 'invalid_destination': 'invalidDestination', 'invalid_source': 'invalidSource', 'logging_enabled': 'loggingEnabled', 'match_translated': 'matchTranslated', 'name': 'name', 'rule_id': 'ruleId', 'rule_tag': 'ruleTag', 'rule_type': 'ruleType', 'source': 'source', 'statistics': 'statistics'}
property description

Gets the description of this Nsxfirewallrule. # noqa: E501

Description for the rule # noqa: E501

Returns

The description of this Nsxfirewallrule. # noqa: E501

Return type

str

property destination

Gets the destination of this Nsxfirewallrule. # noqa: E501

Returns

The destination of this Nsxfirewallrule. # noqa: E501

Return type

AddressFWSourceDestination

property direction

Gets the direction of this Nsxfirewallrule. # noqa: E501

Direction. Possible values in or out. Default is ‘any’. # noqa: E501

Returns

The direction of this Nsxfirewallrule. # noqa: E501

Return type

str

property enabled

Gets the enabled of this Nsxfirewallrule. # noqa: E501

Enable rule. # noqa: E501

Returns

The enabled of this Nsxfirewallrule. # noqa: E501

Return type

bool

property invalid_application

Gets the invalid_application of this Nsxfirewallrule. # noqa: E501

Returns

The invalid_application of this Nsxfirewallrule. # noqa: E501

Return type

bool

property invalid_destination

Gets the invalid_destination of this Nsxfirewallrule. # noqa: E501

Returns

The invalid_destination of this Nsxfirewallrule. # noqa: E501

Return type

bool

property invalid_source

Gets the invalid_source of this Nsxfirewallrule. # noqa: E501

Returns

The invalid_source of this Nsxfirewallrule. # noqa: E501

Return type

bool

property logging_enabled

Gets the logging_enabled of this Nsxfirewallrule. # noqa: E501

Enable logging for the rule. # noqa: E501

Returns

The logging_enabled of this Nsxfirewallrule. # noqa: E501

Return type

bool

property match_translated

Gets the match_translated of this Nsxfirewallrule. # noqa: E501

Defines the order of NAT and Firewall pipeline. When false, firewall happens before NAT. Default : false # noqa: E501

Returns

The match_translated of this Nsxfirewallrule. # noqa: E501

Return type

bool

property name

Gets the name of this Nsxfirewallrule. # noqa: E501

Name for the rule. # noqa: E501

Returns

The name of this Nsxfirewallrule. # noqa: E501

Return type

str

openapi_types = {'action': 'str', 'application': 'Application', 'description': 'str', 'destination': 'AddressFWSourceDestination', 'direction': 'str', 'enabled': 'bool', 'invalid_application': 'bool', 'invalid_destination': 'bool', 'invalid_source': 'bool', 'logging_enabled': 'bool', 'match_translated': 'bool', 'name': 'str', 'rule_id': 'int', 'rule_tag': 'int', 'rule_type': 'str', 'source': 'AddressFWSourceDestination', 'statistics': 'FirewallRuleStats'}
property rule_id

Gets the rule_id of this Nsxfirewallrule. # noqa: E501

Identifier for the rule. # noqa: E501

Returns

The rule_id of this Nsxfirewallrule. # noqa: E501

Return type

int

property rule_tag

Gets the rule_tag of this Nsxfirewallrule. # noqa: E501

Rule tag. Used to specify user-defined ruleId. If not specified NSX Manager will generate ruleId. # noqa: E501

Returns

The rule_tag of this Nsxfirewallrule. # noqa: E501

Return type

int

property rule_type

Gets the rule_type of this Nsxfirewallrule. # noqa: E501

Identifies the type of the rule. internal_high or user. # noqa: E501

Returns

The rule_type of this Nsxfirewallrule. # noqa: E501

Return type

str

property source

Gets the source of this Nsxfirewallrule. # noqa: E501

Returns

The source of this Nsxfirewallrule. # noqa: E501

Return type

AddressFWSourceDestination

property statistics

Gets the statistics of this Nsxfirewallrule. # noqa: E501

Returns

The statistics of this Nsxfirewallrule. # noqa: E501

Return type

FirewallRuleStats

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.nsxfirewallservice module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.nsxfirewallservice.Nsxfirewallservice(source_port=None, protocol=None, port=None, icmp_type=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Nsxfirewallservice - a model defined in OpenAPI

attribute_map = {'icmp_type': 'icmpType', 'port': 'port', 'protocol': 'protocol', 'source_port': 'sourcePort'}
property icmp_type

Gets the icmp_type of this Nsxfirewallservice. # noqa: E501

IcmpType. Only supported when protocol is icmp. Default is ‘any’. # noqa: E501

Returns

The icmp_type of this Nsxfirewallservice. # noqa: E501

Return type

str

openapi_types = {'icmp_type': 'str', 'port': 'list[str]', 'protocol': 'str', 'source_port': 'list[str]'}
property port

Gets the port of this Nsxfirewallservice. # noqa: E501

List of destination ports. # noqa: E501

Returns

The port of this Nsxfirewallservice. # noqa: E501

Return type

list[str]

property protocol

Gets the protocol of this Nsxfirewallservice. # noqa: E501

Protocol. # noqa: E501

Returns

The protocol of this Nsxfirewallservice. # noqa: E501

Return type

str

property source_port

Gets the source_port of this Nsxfirewallservice. # noqa: E501

List of source ports. # noqa: E501

Returns

The source_port of this Nsxfirewallservice. # noqa: E501

Return type

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.nsxl2vpn module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.nsxl2vpn.Nsxl2vpn(listener_ips=None, enabled=None, sites=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Nsxl2vpn - a model defined in OpenAPI

attribute_map = {'enabled': 'enabled', 'listener_ips': 'listenerIps', 'sites': 'sites'}
property enabled

Gets the enabled of this Nsxl2vpn. # noqa: E501

Enabled state of L2 VPN service. # noqa: E501

Returns

The enabled of this Nsxl2vpn. # noqa: E501

Return type

bool

property listener_ips

Gets the listener_ips of this Nsxl2vpn. # noqa: E501

Listener IP addresses. # noqa: E501

Returns

The listener_ips of this Nsxl2vpn. # noqa: E501

Return type

list[str]

openapi_types = {'enabled': 'bool', 'listener_ips': 'list[str]', 'sites': 'Sites'}
property sites

Gets the sites of this Nsxl2vpn. # noqa: E501

Returns

The sites of this Nsxl2vpn. # noqa: E501

Return type

Sites

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.nsxnatrule module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.nsxnatrule.Nsxnatrule(vnic=None, rule_type=None, protocol=None, description=None, rule_id=None, snat_match_destination_port=None, original_address=None, dnat_match_source_address=None, dnat_match_source_port=None, snat_match_destination_address=None, original_port=None, logging_enabled=None, translated_address=None, enabled=None, icmp_type=None, translated_port=None, action=None, rule_tag=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Nsxnatrule - a model defined in OpenAPI

property action

Gets the action of this Nsxnatrule. # noqa: E501

Action for the rule. SNAT or DNAT. # noqa: E501

Returns

The action of this Nsxnatrule. # noqa: E501

Return type

str

attribute_map = {'action': 'action', 'description': 'description', 'dnat_match_source_address': 'dnatMatchSourceAddress', 'dnat_match_source_port': 'dnatMatchSourcePort', 'enabled': 'enabled', 'icmp_type': 'icmpType', 'logging_enabled': 'loggingEnabled', 'original_address': 'originalAddress', 'original_port': 'originalPort', 'protocol': 'protocol', 'rule_id': 'ruleId', 'rule_tag': 'ruleTag', 'rule_type': 'ruleType', 'snat_match_destination_address': 'snatMatchDestinationAddress', 'snat_match_destination_port': 'snatMatchDestinationPort', 'translated_address': 'translatedAddress', 'translated_port': 'translatedPort', 'vnic': 'vnic'}
property description

Gets the description of this Nsxnatrule. # noqa: E501

Description for the rule. # noqa: E501

Returns

The description of this Nsxnatrule. # noqa: E501

Return type

str

property dnat_match_source_address

Gets the dnat_match_source_address of this Nsxnatrule. # noqa: E501

Apply DNAT rule only if traffic has this source address. Default is ‘any’. # noqa: E501

Returns

The dnat_match_source_address of this Nsxnatrule. # noqa: E501

Return type

str

property dnat_match_source_port

Gets the dnat_match_source_port of this Nsxnatrule. # noqa: E501

Apply DNAT rule only if traffic has this source port. Default is ‘any’. # noqa: E501

Returns

The dnat_match_source_port of this Nsxnatrule. # noqa: E501

Return type

str

property enabled

Gets the enabled of this Nsxnatrule. # noqa: E501

Enable rule. # noqa: E501

Returns

The enabled of this Nsxnatrule. # noqa: E501

Return type

bool

property icmp_type

Gets the icmp_type of this Nsxnatrule. # noqa: E501

ICMP type. Only supported when protocol is icmp. Default is ‘any’. # noqa: E501

Returns

The icmp_type of this Nsxnatrule. # noqa: E501

Return type

str

property logging_enabled

Gets the logging_enabled of this Nsxnatrule. # noqa: E501

Enable logging for the rule. # noqa: E501

Returns

The logging_enabled of this Nsxnatrule. # noqa: E501

Return type

bool

openapi_types = {'action': 'str', 'description': 'str', 'dnat_match_source_address': 'str', 'dnat_match_source_port': 'str', 'enabled': 'bool', 'icmp_type': 'str', 'logging_enabled': 'bool', 'original_address': 'str', 'original_port': 'str', 'protocol': 'str', 'rule_id': 'int', 'rule_tag': 'int', 'rule_type': 'str', 'snat_match_destination_address': 'str', 'snat_match_destination_port': 'str', 'translated_address': 'str', 'translated_port': 'str', 'vnic': 'str'}
property original_address

Gets the original_address of this Nsxnatrule. # noqa: E501

Original address or address range. This is the original source address for SNAT rules and the original destination address for DNAT rules. # noqa: E501

Returns

The original_address of this Nsxnatrule. # noqa: E501

Return type

str

property original_port

Gets the original_port of this Nsxnatrule. # noqa: E501

Original port. This is the original source port for SNAT rules, and the original destination port for DNAT rules. # noqa: E501

Returns

The original_port of this Nsxnatrule. # noqa: E501

Return type

str

property protocol

Gets the protocol of this Nsxnatrule. # noqa: E501

Protocol. Default is ‘any’ # noqa: E501

Returns

The protocol of this Nsxnatrule. # noqa: E501

Return type

str

property rule_id

Gets the rule_id of this Nsxnatrule. # noqa: E501

Identifier for the rule. # noqa: E501

Returns

The rule_id of this Nsxnatrule. # noqa: E501

Return type

int

property rule_tag

Gets the rule_tag of this Nsxnatrule. # noqa: E501

Rule tag. Used to specify user-defined ruleId. If not specified NSX Manager will generate ruleId. # noqa: E501

Returns

The rule_tag of this Nsxnatrule. # noqa: E501

Return type

int

property rule_type

Gets the rule_type of this Nsxnatrule. # noqa: E501

Identifies the type of the rule. internal_high or user. # noqa: E501

Returns

The rule_type of this Nsxnatrule. # noqa: E501

Return type

str

property snat_match_destination_address

Gets the snat_match_destination_address of this Nsxnatrule. # noqa: E501

Apply SNAT rule only if traffic has this destination address. Default is ‘any’. # noqa: E501

Returns

The snat_match_destination_address of this Nsxnatrule. # noqa: E501

Return type

str

property snat_match_destination_port

Gets the snat_match_destination_port of this Nsxnatrule. # noqa: E501

Apply SNAT rule only if traffic has this destination port. Default is ‘any’. # noqa: E501

Returns

The snat_match_destination_port of this Nsxnatrule. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property translated_address

Gets the translated_address of this Nsxnatrule. # noqa: E501

Translated address or address range. # noqa: E501

Returns

The translated_address of this Nsxnatrule. # noqa: E501

Return type

str

property translated_port

Gets the translated_port of this Nsxnatrule. # noqa: E501

Translated port. Supported in DNAT rules only. # noqa: E501

Returns

The translated_port of this Nsxnatrule. # noqa: E501

Return type

str

property vnic

Gets the vnic of this Nsxnatrule. # noqa: E501

Interface on which the NAT rule is applied. # noqa: E501

Returns

The vnic of this Nsxnatrule. # noqa: E501

Return type

str

vmware.vmc.console.models.nsxsite module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.nsxsite.Nsxsite(secure_traffic=None, site_id=None, name=None, password=None, user_id=None, description=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Nsxsite - a model defined in OpenAPI

attribute_map = {'description': 'description', 'name': 'name', 'password': 'password', 'secure_traffic': 'secureTraffic', 'site_id': 'siteId', 'user_id': 'userId'}
property description

Gets the description of this Nsxsite. # noqa: E501

Description of L2 VPN site. # noqa: E501

Returns

The description of this Nsxsite. # noqa: E501

Return type

str

property name

Gets the name of this Nsxsite. # noqa: E501

Name of L2 VPN site. Length: 1-255 characters. # noqa: E501

Returns

The name of this Nsxsite. # noqa: E501

Return type

str

openapi_types = {'description': 'str', 'name': 'str', 'password': 'str', 'secure_traffic': 'bool', 'site_id': 'str', 'user_id': 'str'}
property password

Gets the password of this Nsxsite. # noqa: E501

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. # noqa: E501

Returns

The password of this Nsxsite. # noqa: E501

Return type

str

property secure_traffic

Gets the secure_traffic of this Nsxsite. # noqa: E501

Secure L2VPN traffic. # noqa: E501

Returns

The secure_traffic of this Nsxsite. # noqa: E501

Return type

bool

property site_id

Gets the site_id of this Nsxsite. # noqa: E501

Identifier for L2 VPN site. # noqa: E501

Returns

The site_id of this Nsxsite. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property user_id

Gets the user_id of this Nsxsite. # noqa: E501

L2 VPN user ID. Valid user names: 1-63 characters, letters and numbers only. No white space or special characters. # noqa: E501

Returns

The user_id of this Nsxsite. # noqa: E501

Return type

str

vmware.vmc.console.models.nsxt_addons module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.nsxt_addons.NsxtAddons(enable_nsx_advanced_addon=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

NsxtAddons - a model defined in OpenAPI

attribute_map = {'enable_nsx_advanced_addon': 'enable_nsx_advanced_addon'}
property enable_nsx_advanced_addon

Gets the enable_nsx_advanced_addon of this NsxtAddons. # noqa: E501

Indicates whether NSX Advanced addon is enabled or disabled. # noqa: E501

Returns

The enable_nsx_advanced_addon of this NsxtAddons. # noqa: E501

Return type

bool

openapi_types = {'enable_nsx_advanced_addon': 'bool'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.object_type module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.object_type.ObjectType(name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ObjectType - a model defined in OpenAPI

attribute_map = {'name': 'name'}
property name

Gets the name of this ObjectType. # noqa: E501

Returns

The name of this ObjectType. # noqa: E501

Return type

str

openapi_types = {'name': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.offer_instances_holder module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.offer_instances_holder.OfferInstancesHolder(on_demand=None, offers=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

OfferInstancesHolder - a model defined in OpenAPI

attribute_map = {'offers': 'offers', 'on_demand': 'on_demand'}
property offers

Gets the offers of this OfferInstancesHolder. # noqa: E501

Returns

The offers of this OfferInstancesHolder. # noqa: E501

Return type

list[TermOfferInstance]

property on_demand

Gets the on_demand of this OfferInstancesHolder. # noqa: E501

Returns

The on_demand of this OfferInstancesHolder. # noqa: E501

Return type

OnDemandOfferInstance

openapi_types = {'offers': 'list[TermOfferInstance]', 'on_demand': 'OnDemandOfferInstance'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.offer_type module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.offer_type.OfferType(local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

OfferType - a model defined in OpenAPI

ON_DEMAND = 'ON_DEMAND'
TERM = 'TERM'
allowable_values = ['TERM', 'ON_DEMAND']
Attributes:
openapi_types (dict): The key is attribute name

and the value is attribute type.

attribute_map (dict): The key is attribute name

and the value is json key in definition.

attribute_map = {}
openapi_types = {}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.on_demand_offer_instance module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.on_demand_offer_instance.OnDemandOfferInstance(product=None, product_type=None, name=None, currency=None, region=None, unit_price=None, monthly_cost=None, version=None, type=None, description=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

OnDemandOfferInstance - a model defined in OpenAPI

attribute_map = {'currency': 'currency', 'description': 'description', 'monthly_cost': 'monthly_cost', 'name': 'name', 'product': 'product', 'product_type': 'product_type', 'region': 'region', 'type': 'type', 'unit_price': 'unit_price', 'version': 'version'}
property currency

Gets the currency of this OnDemandOfferInstance. # noqa: E501

Returns

The currency of this OnDemandOfferInstance. # noqa: E501

Return type

str

property description

Gets the description of this OnDemandOfferInstance. # noqa: E501

Returns

The description of this OnDemandOfferInstance. # noqa: E501

Return type

str

property monthly_cost

Gets the monthly_cost of this OnDemandOfferInstance. # noqa: E501

Returns

The monthly_cost of this OnDemandOfferInstance. # noqa: E501

Return type

str

property name

Gets the name of this OnDemandOfferInstance. # noqa: E501

Returns

The name of this OnDemandOfferInstance. # noqa: E501

Return type

str

openapi_types = {'currency': 'str', 'description': 'str', 'monthly_cost': 'str', 'name': 'str', 'product': 'str', 'product_type': 'str', 'region': 'str', 'type': 'str', 'unit_price': 'str', 'version': 'str'}
property product

Gets the product of this OnDemandOfferInstance. # noqa: E501

Returns

The product of this OnDemandOfferInstance. # noqa: E501

Return type

str

property product_type

Gets the product_type of this OnDemandOfferInstance. # noqa: E501

Deprecated. Please use product and type fields instead. # noqa: E501

Returns

The product_type of this OnDemandOfferInstance. # noqa: E501

Return type

str

property region

Gets the region of this OnDemandOfferInstance. # noqa: E501

Returns

The region of this OnDemandOfferInstance. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this OnDemandOfferInstance. # noqa: E501

Returns

The type of this OnDemandOfferInstance. # noqa: E501

Return type

str

property unit_price

Gets the unit_price of this OnDemandOfferInstance. # noqa: E501

Returns

The unit_price of this OnDemandOfferInstance. # noqa: E501

Return type

str

property version

Gets the version of this OnDemandOfferInstance. # noqa: E501

Returns

The version of this OnDemandOfferInstance. # noqa: E501

Return type

str

vmware.vmc.console.models.org_properties module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.org_properties.OrgProperties(values=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

OrgProperties - a model defined in OpenAPI

attribute_map = {'values': 'values'}
openapi_types = {'values': 'dict(str, str)'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property values

Gets the values of this OrgProperties. # noqa: E501

A map of string properties to values. # noqa: E501

Returns

The values of this OrgProperties. # noqa: E501

Return type

dict(str, str)

vmware.vmc.console.models.org_seller_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.org_seller_info.OrgSellerInfo(seller_account_id=None, seller=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

OrgSellerInfo - a model defined in OpenAPI

attribute_map = {'seller': 'seller', 'seller_account_id': 'seller_account_id'}
openapi_types = {'seller': 'str', 'seller_account_id': 'str'}
property seller

Gets the seller of this OrgSellerInfo. # noqa: E501

The seller-of-record for the current organization. For example AWS or VMWARE # noqa: E501

Returns

The seller of this OrgSellerInfo. # noqa: E501

Return type

str

property seller_account_id

Gets the seller_account_id of this OrgSellerInfo. # noqa: E501

The accountid for this org for the seller-of-record. NILLABLE. # noqa: E501

Returns

The seller_account_id of this OrgSellerInfo. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.organization module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.organization.Organization(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, org_type=None, display_name=None, name=None, org_seller_info=None, project_state=None, properties=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Organization - a model defined in OpenAPI

attribute_map = {'created': 'created', 'display_name': 'display_name', 'id': 'id', 'name': 'name', 'org_seller_info': 'org_seller_info', 'org_type': 'org_type', 'project_state': 'project_state', 'properties': 'properties', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version'}
property created

Gets the created of this Organization. # noqa: E501

Returns

The created of this Organization. # noqa: E501

Return type

datetime

property display_name

Gets the display_name of this Organization. # noqa: E501

Returns

The display_name of this Organization. # noqa: E501

Return type

str

property id

Gets the id of this Organization. # noqa: E501

Unique ID for this entity # noqa: E501

Returns

The id of this Organization. # noqa: E501

Return type

str

property name

Gets the name of this Organization. # noqa: E501

Returns

The name of this Organization. # noqa: E501

Return type

str

openapi_types = {'created': 'datetime', 'display_name': 'str', 'id': 'str', 'name': 'str', 'org_seller_info': 'OrgSellerInfo', 'org_type': 'str', 'project_state': 'str', 'properties': 'OrgProperties', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int'}
property org_seller_info

Gets the org_seller_info of this Organization. # noqa: E501

Returns

The org_seller_info of this Organization. # noqa: E501

Return type

OrgSellerInfo

property org_type

Gets the org_type of this Organization. # noqa: E501

ORG_TYPE to be associated with the org # noqa: E501

Returns

The org_type of this Organization. # noqa: E501

Return type

str

property project_state

Gets the project_state of this Organization. # noqa: E501

Returns

The project_state of this Organization. # noqa: E501

Return type

str

property properties

Gets the properties of this Organization. # noqa: E501

Returns

The properties of this Organization. # noqa: E501

Return type

OrgProperties

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property updated

Gets the updated of this Organization. # noqa: E501

Returns

The updated of this Organization. # noqa: E501

Return type

datetime

property updated_by_user_id

Gets the updated_by_user_id of this Organization. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The updated_by_user_id of this Organization. # noqa: E501

Return type

str

property updated_by_user_name

Gets the updated_by_user_name of this Organization. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The updated_by_user_name of this Organization. # noqa: E501

Return type

str

property user_id

Gets the user_id of this Organization. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The user_id of this Organization. # noqa: E501

Return type

str

property user_name

Gets the user_name of this Organization. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The user_name of this Organization. # noqa: E501

Return type

str

property version

Gets the version of this Organization. # noqa: E501

Version of this entity # noqa: E501

Returns

The version of this Organization. # noqa: E501

Return type

int

vmware.vmc.console.models.organization_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.organization_all_of.OrganizationAllOf(org_type=None, display_name=None, name=None, org_seller_info=None, project_state=None, properties=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

OrganizationAllOf - a model defined in OpenAPI

attribute_map = {'display_name': 'display_name', 'name': 'name', 'org_seller_info': 'org_seller_info', 'org_type': 'org_type', 'project_state': 'project_state', 'properties': 'properties'}
property display_name

Gets the display_name of this OrganizationAllOf. # noqa: E501

Returns

The display_name of this OrganizationAllOf. # noqa: E501

Return type

str

property name

Gets the name of this OrganizationAllOf. # noqa: E501

Returns

The name of this OrganizationAllOf. # noqa: E501

Return type

str

openapi_types = {'display_name': 'str', 'name': 'str', 'org_seller_info': 'OrgSellerInfo', 'org_type': 'str', 'project_state': 'str', 'properties': 'OrgProperties'}
property org_seller_info

Gets the org_seller_info of this OrganizationAllOf. # noqa: E501

Returns

The org_seller_info of this OrganizationAllOf. # noqa: E501

Return type

OrgSellerInfo

property org_type

Gets the org_type of this OrganizationAllOf. # noqa: E501

ORG_TYPE to be associated with the org # noqa: E501

Returns

The org_type of this OrganizationAllOf. # noqa: E501

Return type

str

property project_state

Gets the project_state of this OrganizationAllOf. # noqa: E501

Returns

The project_state of this OrganizationAllOf. # noqa: E501

Return type

str

property properties

Gets the properties of this OrganizationAllOf. # noqa: E501

Returns

The properties of this OrganizationAllOf. # noqa: E501

Return type

OrgProperties

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.paged_edge_list module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.paged_edge_list.PagedEdgeList(edge_page=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

PagedEdgeList - a model defined in OpenAPI

attribute_map = {'edge_page': 'edgePage'}
property edge_page

Gets the edge_page of this PagedEdgeList. # noqa: E501

Returns

The edge_page of this PagedEdgeList. # noqa: E501

Return type

DataPageEdgeSummary

openapi_types = {'edge_page': 'DataPageEdgeSummary'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.paging_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.paging_info.PagingInfo(sort_order_ascending=None, total_count=None, start_index=None, sort_by=None, page_size=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

PagingInfo - a model defined in OpenAPI

attribute_map = {'page_size': 'pageSize', 'sort_by': 'sortBy', 'sort_order_ascending': 'sortOrderAscending', 'start_index': 'startIndex', 'total_count': 'totalCount'}
openapi_types = {'page_size': 'int', 'sort_by': 'str', 'sort_order_ascending': 'bool', 'start_index': 'int', 'total_count': 'int'}
property page_size

Gets the page_size of this PagingInfo. # noqa: E501

Returns

The page_size of this PagingInfo. # noqa: E501

Return type

int

property sort_by

Gets the sort_by of this PagingInfo. # noqa: E501

Returns

The sort_by of this PagingInfo. # noqa: E501

Return type

str

property sort_order_ascending

Gets the sort_order_ascending of this PagingInfo. # noqa: E501

Returns

The sort_order_ascending of this PagingInfo. # noqa: E501

Return type

bool

property start_index

Gets the start_index of this PagingInfo. # noqa: E501

Returns

The start_index of this PagingInfo. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property total_count

Gets the total_count of this PagingInfo. # noqa: E501

Returns

The total_count of this PagingInfo. # noqa: E501

Return type

int

vmware.vmc.console.models.payment_method_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.payment_method_info.PaymentMethodInfo(type=None, default_flag=None, payment_method_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

PaymentMethodInfo - a model defined in OpenAPI

attribute_map = {'default_flag': 'default_flag', 'payment_method_id': 'payment_method_id', 'type': 'type'}
property default_flag

Gets the default_flag of this PaymentMethodInfo. # noqa: E501

Returns

The default_flag of this PaymentMethodInfo. # noqa: E501

Return type

bool

openapi_types = {'default_flag': 'bool', 'payment_method_id': 'str', 'type': 'str'}
property payment_method_id

Gets the payment_method_id of this PaymentMethodInfo. # noqa: E501

Returns

The payment_method_id of this PaymentMethodInfo. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this PaymentMethodInfo. # noqa: E501

Returns

The type of this PaymentMethodInfo. # noqa: E501

Return type

str

vmware.vmc.console.models.pop_agent_xeni_connection module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.pop_agent_xeni_connection.PopAgentXeniConnection(default_subnet_route=None, eni_info=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

PopAgentXeniConnection - a model defined in OpenAPI

attribute_map = {'default_subnet_route': 'default_subnet_route', 'eni_info': 'eni_info'}
property default_subnet_route

Gets the default_subnet_route of this PopAgentXeniConnection. # noqa: E501

The gateway route ip fo the subnet. # noqa: E501

Returns

The default_subnet_route of this PopAgentXeniConnection. # noqa: E501

Return type

str

property eni_info

Gets the eni_info of this PopAgentXeniConnection. # noqa: E501

Returns

The eni_info of this PopAgentXeniConnection. # noqa: E501

Return type

EniInfo

openapi_types = {'default_subnet_route': 'str', 'eni_info': 'EniInfo'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.pop_ami_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.pop_ami_info.PopAmiInfo(instance_type=None, region=None, id=None, name=None, type='POP', local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

PopAmiInfo - a model defined in OpenAPI

attribute_map = {'id': 'id', 'instance_type': 'instance_type', 'name': 'name', 'region': 'region', 'type': 'type'}
property id

Gets the id of this PopAmiInfo. # noqa: E501

the ami id for the esx # noqa: E501

Returns

The id of this PopAmiInfo. # noqa: E501

Return type

str

property instance_type

Gets the instance_type of this PopAmiInfo. # noqa: E501

instance type of the esx ami # noqa: E501

Returns

The instance_type of this PopAmiInfo. # noqa: E501

Return type

str

property name

Gets the name of this PopAmiInfo. # noqa: E501

the name of the esx ami # noqa: E501

Returns

The name of this PopAmiInfo. # noqa: E501

Return type

str

openapi_types = {'id': 'str', 'instance_type': 'str', 'name': 'str', 'region': 'str', 'type': 'str'}
property region

Gets the region of this PopAmiInfo. # noqa: E501

the region of the esx ami # noqa: E501

Returns

The region of this PopAmiInfo. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this PopAmiInfo. # noqa: E501

PoP AMI type. CENTOS: a Centos AMI; POP: a PoP AMI. # noqa: E501

Returns

The type of this PopAmiInfo. # noqa: E501

Return type

str

vmware.vmc.console.models.pop_ami_info_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.pop_ami_info_all_of.PopAmiInfoAllOf(type='POP', local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

PopAmiInfoAllOf - a model defined in OpenAPI

attribute_map = {'type': 'type'}
openapi_types = {'type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this PopAmiInfoAllOf. # noqa: E501

PoP AMI type. CENTOS: a Centos AMI; POP: a PoP AMI. # noqa: E501

Returns

The type of this PopAmiInfoAllOf. # noqa: E501

Return type

str

vmware.vmc.console.models.pop_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.pop_info.PopInfo(ami_infos=None, created_at=None, service_infos=None, id=None, manifest_version=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

PopInfo - a model defined in OpenAPI

property ami_infos

Gets the ami_infos of this PopInfo. # noqa: E501

A map of [region name of PoP / PoP-AMI]:[PopAmiInfo]. # noqa: E501

Returns

The ami_infos of this PopInfo. # noqa: E501

Return type

dict(str, PopAmiInfo)

attribute_map = {'ami_infos': 'ami_infos', 'created_at': 'created_at', 'id': 'id', 'manifest_version': 'manifest_version', 'service_infos': 'service_infos'}
property created_at

Gets the created_at of this PopInfo. # noqa: E501

The PopInfo (or PoP AMI) created time. Using ISO 8601 date-time pattern. # noqa: E501

Returns

The created_at of this PopInfo. # noqa: E501

Return type

datetime

property id

Gets the id of this PopInfo. # noqa: E501

UUID of the PopInfo # noqa: E501

Returns

The id of this PopInfo. # noqa: E501

Return type

str

property manifest_version

Gets the manifest_version of this PopInfo. # noqa: E501

version of the manifest. # noqa: E501

Returns

The manifest_version of this PopInfo. # noqa: E501

Return type

str

openapi_types = {'ami_infos': 'dict(str, PopAmiInfo)', 'created_at': 'datetime', 'id': 'str', 'manifest_version': 'str', 'service_infos': 'dict(str, PopServiceInfo)'}
property service_infos

Gets the service_infos of this PopInfo. # noqa: E501

A map of [service type]:[PopServiceInfo] # noqa: E501

Returns

The service_infos of this PopInfo. # noqa: E501

Return type

dict(str, PopServiceInfo)

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.pop_service_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.pop_service_info.PopServiceInfo(cln=None, version=None, build=None, service=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

PopServiceInfo - a model defined in OpenAPI

attribute_map = {'build': 'build', 'cln': 'cln', 'service': 'service', 'version': 'version'}
property build

Gets the build of this PopServiceInfo. # noqa: E501

The service build number. # noqa: E501

Returns

The build of this PopServiceInfo. # noqa: E501

Return type

str

property cln

Gets the cln of this PopServiceInfo. # noqa: E501

The service change set number. # noqa: E501

Returns

The cln of this PopServiceInfo. # noqa: E501

Return type

str

openapi_types = {'build': 'str', 'cln': 'str', 'service': 'str', 'version': 'str'}
property service

Gets the service of this PopServiceInfo. # noqa: E501

An enum of PoP related services (including os platform and JRE). # noqa: E501

Returns

The service of this PopServiceInfo. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this PopServiceInfo. # noqa: E501

The service API version. # noqa: E501

Returns

The version of this PopServiceInfo. # noqa: E501

Return type

str

vmware.vmc.console.models.provision_spec module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.provision_spec.ProvisionSpec(provider=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ProvisionSpec - a model defined in OpenAPI

attribute_map = {'provider': 'provider'}
openapi_types = {'provider': 'dict(str, SddcConfigSpec)'}
property provider

Gets the provider of this ProvisionSpec. # noqa: E501

Map of provider to sddc config spec # noqa: E501

Returns

The provider of this ProvisionSpec. # noqa: E501

Return type

dict(str, SddcConfigSpec)

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.requests module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.requests.Requests(total=None, queries=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Requests - a model defined in OpenAPI

attribute_map = {'queries': 'queries', 'total': 'total'}
openapi_types = {'queries': 'int', 'total': 'int'}
property queries

Gets the queries of this Requests. # noqa: E501

Returns

The queries of this Requests. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property total

Gets the total of this Requests. # noqa: E501

Returns

The total of this Requests. # noqa: E501

Return type

int

vmware.vmc.console.models.reservation module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.reservation.Reservation(duration=None, rid=None, create_time=None, start_time=None, metadata=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Reservation - a model defined in OpenAPI

attribute_map = {'create_time': 'create_time', 'duration': 'duration', 'metadata': 'metadata', 'rid': 'rid', 'start_time': 'start_time'}
property create_time

Gets the create_time of this Reservation. # noqa: E501

Optional # noqa: E501

Returns

The create_time of this Reservation. # noqa: E501

Return type

str

property duration

Gets the duration of this Reservation. # noqa: E501

Duration - required for reservation in maintenance window # noqa: E501

Returns

The duration of this Reservation. # noqa: E501

Return type

int

property metadata

Gets the metadata of this Reservation. # noqa: E501

Optional # noqa: E501

Returns

The metadata of this Reservation. # noqa: E501

Return type

dict(str, str)

openapi_types = {'create_time': 'str', 'duration': 'int', 'metadata': 'dict(str, str)', 'rid': 'str', 'start_time': 'datetime'}
property rid

Gets the rid of this Reservation. # noqa: E501

Reservation ID # noqa: E501

Returns

The rid of this Reservation. # noqa: E501

Return type

str

property start_time

Gets the start_time of this Reservation. # noqa: E501

Start time of a reservation # noqa: E501

Returns

The start_time of this Reservation. # noqa: E501

Return type

datetime

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.reservation_in_mw module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.reservation_in_mw.ReservationInMw(rid=None, week_of=None, create_time=None, metadata=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ReservationInMw - a model defined in OpenAPI

attribute_map = {'create_time': 'create_time', 'metadata': 'metadata', 'rid': 'rid', 'week_of': 'week_of'}
property create_time

Gets the create_time of this ReservationInMw. # noqa: E501

Optional # noqa: E501

Returns

The create_time of this ReservationInMw. # noqa: E501

Return type

datetime

property metadata

Gets the metadata of this ReservationInMw. # noqa: E501

Optional # noqa: E501

Returns

The metadata of this ReservationInMw. # noqa: E501

Return type

dict(str, str)

openapi_types = {'create_time': 'datetime', 'metadata': 'dict(str, str)', 'rid': 'str', 'week_of': 'str'}
property rid

Gets the rid of this ReservationInMw. # noqa: E501

Reservation ID # noqa: E501

Returns

The rid of this ReservationInMw. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property week_of

Gets the week_of of this ReservationInMw. # noqa: E501

SUNDAY of the week that maintenance is scheduled, ISO format date # noqa: E501

Returns

The week_of of this ReservationInMw. # noqa: E501

Return type

str

vmware.vmc.console.models.reservation_schedule module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.reservation_schedule.ReservationSchedule(day_of_week=None, hour_of_day=None, duration_min=None, version=None, reservations=None, reservations_mw=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ReservationSchedule - a model defined in OpenAPI

attribute_map = {'day_of_week': 'day_of_week', 'duration_min': 'duration_min', 'hour_of_day': 'hour_of_day', 'reservations': 'reservations', 'reservations_mw': 'reservations_mw', 'version': 'version'}
property day_of_week

Gets the day_of_week of this ReservationSchedule. # noqa: E501

Returns

The day_of_week of this ReservationSchedule. # noqa: E501

Return type

str

property duration_min

Gets the duration_min of this ReservationSchedule. # noqa: E501

Returns

The duration_min of this ReservationSchedule. # noqa: E501

Return type

int

property hour_of_day

Gets the hour_of_day of this ReservationSchedule. # noqa: E501

Returns

The hour_of_day of this ReservationSchedule. # noqa: E501

Return type

int

openapi_types = {'day_of_week': 'str', 'duration_min': 'int', 'hour_of_day': 'int', 'reservations': 'list[Reservation]', 'reservations_mw': 'list[ReservationInMw]', 'version': 'int'}
property reservations

Gets the reservations of this ReservationSchedule. # noqa: E501

Returns

The reservations of this ReservationSchedule. # noqa: E501

Return type

list[Reservation]

property reservations_mw

Gets the reservations_mw of this ReservationSchedule. # noqa: E501

Returns

The reservations_mw of this ReservationSchedule. # noqa: E501

Return type

list[ReservationInMw]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property version

Gets the version of this ReservationSchedule. # noqa: E501

Returns

The version of this ReservationSchedule. # noqa: E501

Return type

int

vmware.vmc.console.models.reservation_schedule_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.reservation_schedule_all_of.ReservationScheduleAllOf(reservations=None, reservations_mw=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ReservationScheduleAllOf - a model defined in OpenAPI

attribute_map = {'reservations': 'reservations', 'reservations_mw': 'reservations_mw'}
openapi_types = {'reservations': 'list[Reservation]', 'reservations_mw': 'list[ReservationInMw]'}
property reservations

Gets the reservations of this ReservationScheduleAllOf. # noqa: E501

Returns

The reservations of this ReservationScheduleAllOf. # noqa: E501

Return type

list[Reservation]

property reservations_mw

Gets the reservations_mw of this ReservationScheduleAllOf. # noqa: E501

Returns

The reservations_mw of this ReservationScheduleAllOf. # noqa: E501

Return type

list[ReservationInMw]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.reservation_window module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.reservation_window.ReservationWindow(reservation_state=None, emergency=None, maintenance_properties=None, reserve_id=None, start_hour=None, sddc_id=None, manifest_id=None, duration_hours=None, start_date=None, metadata=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ReservationWindow - a model defined in OpenAPI

attribute_map = {'duration_hours': 'duration_hours', 'emergency': 'emergency', 'maintenance_properties': 'maintenance_properties', 'manifest_id': 'manifest_id', 'metadata': 'metadata', 'reservation_state': 'reservation_state', 'reserve_id': 'reserve_id', 'sddc_id': 'sddc_id', 'start_date': 'start_date', 'start_hour': 'start_hour'}
property duration_hours

Gets the duration_hours of this ReservationWindow. # noqa: E501

Returns

The duration_hours of this ReservationWindow. # noqa: E501

Return type

int

property emergency

Gets the emergency of this ReservationWindow. # noqa: E501

Returns

The emergency of this ReservationWindow. # noqa: E501

Return type

bool

property maintenance_properties

Gets the maintenance_properties of this ReservationWindow. # noqa: E501

Returns

The maintenance_properties of this ReservationWindow. # noqa: E501

Return type

ReservationWindowMaintenanceProperties

property manifest_id

Gets the manifest_id of this ReservationWindow. # noqa: E501

Returns

The manifest_id of this ReservationWindow. # noqa: E501

Return type

str

property metadata

Gets the metadata of this ReservationWindow. # noqa: E501

Metadata for reservation window, in key-value form # noqa: E501

Returns

The metadata of this ReservationWindow. # noqa: E501

Return type

dict(str, str)

openapi_types = {'duration_hours': 'int', 'emergency': 'bool', 'maintenance_properties': 'ReservationWindowMaintenanceProperties', 'manifest_id': 'str', 'metadata': 'dict(str, str)', 'reservation_state': 'str', 'reserve_id': 'str', 'sddc_id': 'str', 'start_date': 'str', 'start_hour': 'int'}
property reservation_state

Gets the reservation_state of this ReservationWindow. # noqa: E501

Returns

The reservation_state of this ReservationWindow. # noqa: E501

Return type

str

property reserve_id

Gets the reserve_id of this ReservationWindow. # noqa: E501

Returns

The reserve_id of this ReservationWindow. # noqa: E501

Return type

str

property sddc_id

Gets the sddc_id of this ReservationWindow. # noqa: E501

Returns

The sddc_id of this ReservationWindow. # noqa: E501

Return type

str

property start_date

Gets the start_date of this ReservationWindow. # noqa: E501

Returns

The start_date of this ReservationWindow. # noqa: E501

Return type

str

property start_hour

Gets the start_hour of this ReservationWindow. # noqa: E501

Returns

The start_hour of this ReservationWindow. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.reservation_window_maintenance_properties module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.reservation_window_maintenance_properties.ReservationWindowMaintenanceProperties(status=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ReservationWindowMaintenanceProperties - a model defined in OpenAPI

attribute_map = {'status': 'status'}
openapi_types = {'status': 'str'}
property status

Gets the status of this ReservationWindowMaintenanceProperties. # noqa: E501

Status of upgrade, if any # noqa: E501

Returns

The status of this ReservationWindowMaintenanceProperties. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.result module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.result.Result(value=None, key=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Result - a model defined in OpenAPI

attribute_map = {'key': 'key', 'value': 'value'}
property key

Gets the key of this Result. # noqa: E501

Job Result key ID. # noqa: E501

Returns

The key of this Result. # noqa: E501

Return type

str

openapi_types = {'key': 'str', 'value': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property value

Gets the value of this Result. # noqa: E501

Job Result value associated with key ID. # noqa: E501

Returns

The value of this Result. # noqa: E501

Return type

str

vmware.vmc.console.models.route_table_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.route_table_info.RouteTableInfo(name=None, id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

RouteTableInfo - a model defined in OpenAPI

attribute_map = {'id': 'id', 'name': 'name'}
property id

Gets the id of this RouteTableInfo. # noqa: E501

route table id # noqa: E501

Returns

The id of this RouteTableInfo. # noqa: E501

Return type

str

property name

Gets the name of this RouteTableInfo. # noqa: E501

route table name # noqa: E501

Returns

The name of this RouteTableInfo. # noqa: E501

Return type

str

openapi_types = {'id': 'str', 'name': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.scope_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.scope_info.ScopeInfo(object_type_name=None, id=None, name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ScopeInfo - a model defined in OpenAPI

attribute_map = {'id': 'id', 'name': 'name', 'object_type_name': 'objectTypeName'}
property id

Gets the id of this ScopeInfo. # noqa: E501

Returns

The id of this ScopeInfo. # noqa: E501

Return type

str

property name

Gets the name of this ScopeInfo. # noqa: E501

Returns

The name of this ScopeInfo. # noqa: E501

Return type

str

property object_type_name

Gets the object_type_name of this ScopeInfo. # noqa: E501

Returns

The object_type_name of this ScopeInfo. # noqa: E501

Return type

str

openapi_types = {'id': 'str', 'name': 'str', 'object_type_name': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc.Sddc(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, name=None, sddc_state=None, expiration_date=None, org_id=None, sddc_type=None, provider=None, account_link_state=None, sddc_access_state=None, resource_config=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Sddc - a model defined in OpenAPI

Gets the account_link_state of this Sddc. # noqa: E501

Account linking state of the sddc # noqa: E501

Returns

The account_link_state of this Sddc. # noqa: E501

Return type

str

attribute_map = {'account_link_state': 'account_link_state', 'created': 'created', 'expiration_date': 'expiration_date', 'id': 'id', 'name': 'name', 'org_id': 'org_id', 'provider': 'provider', 'resource_config': 'resource_config', 'sddc_access_state': 'sddc_access_state', 'sddc_state': 'sddc_state', 'sddc_type': 'sddc_type', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version'}
property created

Gets the created of this Sddc. # noqa: E501

Returns

The created of this Sddc. # noqa: E501

Return type

datetime

property expiration_date

Gets the expiration_date of this Sddc. # noqa: E501

Expiration date of a sddc in UTC (will be set if its applicable) # noqa: E501

Returns

The expiration_date of this Sddc. # noqa: E501

Return type

datetime

property id

Gets the id of this Sddc. # noqa: E501

Unique ID for this entity # noqa: E501

Returns

The id of this Sddc. # noqa: E501

Return type

str

property name

Gets the name of this Sddc. # noqa: E501

name for SDDC # noqa: E501

Returns

The name of this Sddc. # noqa: E501

Return type

str

openapi_types = {'account_link_state': 'str', 'created': 'datetime', 'expiration_date': 'datetime', 'id': 'str', 'name': 'str', 'org_id': 'str', 'provider': 'str', 'resource_config': 'AwsSddcResourceConfig', 'sddc_access_state': 'str', 'sddc_state': 'str', 'sddc_type': 'str', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int'}
property org_id

Gets the org_id of this Sddc. # noqa: E501

Returns

The org_id of this Sddc. # noqa: E501

Return type

str

property provider

Gets the provider of this Sddc. # noqa: E501

Returns

The provider of this Sddc. # noqa: E501

Return type

str

property resource_config

Gets the resource_config of this Sddc. # noqa: E501

Returns

The resource_config of this Sddc. # noqa: E501

Return type

AwsSddcResourceConfig

property sddc_access_state

Gets the sddc_access_state of this Sddc. # noqa: E501

Describes the access state of sddc, valid state is DISABLED or ENABLED # noqa: E501

Returns

The sddc_access_state of this Sddc. # noqa: E501

Return type

str

property sddc_state

Gets the sddc_state of this Sddc. # noqa: E501

Returns

The sddc_state of this Sddc. # noqa: E501

Return type

str

property sddc_type

Gets the sddc_type of this Sddc. # noqa: E501

Type of the sddc # noqa: E501

Returns

The sddc_type of this Sddc. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property updated

Gets the updated of this Sddc. # noqa: E501

Returns

The updated of this Sddc. # noqa: E501

Return type

datetime

property updated_by_user_id

Gets the updated_by_user_id of this Sddc. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The updated_by_user_id of this Sddc. # noqa: E501

Return type

str

property updated_by_user_name

Gets the updated_by_user_name of this Sddc. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The updated_by_user_name of this Sddc. # noqa: E501

Return type

str

property user_id

Gets the user_id of this Sddc. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The user_id of this Sddc. # noqa: E501

Return type

str

property user_name

Gets the user_name of this Sddc. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The user_name of this Sddc. # noqa: E501

Return type

str

property version

Gets the version of this Sddc. # noqa: E501

Version of this entity # noqa: E501

Returns

The version of this Sddc. # noqa: E501

Return type

int

vmware.vmc.console.models.sddc_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_all_of.SddcAllOf(name=None, sddc_state=None, expiration_date=None, org_id=None, sddc_type=None, provider=None, account_link_state=None, sddc_access_state=None, resource_config=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcAllOf - a model defined in OpenAPI

Gets the account_link_state of this SddcAllOf. # noqa: E501

Account linking state of the sddc # noqa: E501

Returns

The account_link_state of this SddcAllOf. # noqa: E501

Return type

str

attribute_map = {'account_link_state': 'account_link_state', 'expiration_date': 'expiration_date', 'name': 'name', 'org_id': 'org_id', 'provider': 'provider', 'resource_config': 'resource_config', 'sddc_access_state': 'sddc_access_state', 'sddc_state': 'sddc_state', 'sddc_type': 'sddc_type'}
property expiration_date

Gets the expiration_date of this SddcAllOf. # noqa: E501

Expiration date of a sddc in UTC (will be set if its applicable) # noqa: E501

Returns

The expiration_date of this SddcAllOf. # noqa: E501

Return type

datetime

property name

Gets the name of this SddcAllOf. # noqa: E501

name for SDDC # noqa: E501

Returns

The name of this SddcAllOf. # noqa: E501

Return type

str

openapi_types = {'account_link_state': 'str', 'expiration_date': 'datetime', 'name': 'str', 'org_id': 'str', 'provider': 'str', 'resource_config': 'AwsSddcResourceConfig', 'sddc_access_state': 'str', 'sddc_state': 'str', 'sddc_type': 'str'}
property org_id

Gets the org_id of this SddcAllOf. # noqa: E501

Returns

The org_id of this SddcAllOf. # noqa: E501

Return type

str

property provider

Gets the provider of this SddcAllOf. # noqa: E501

Returns

The provider of this SddcAllOf. # noqa: E501

Return type

str

property resource_config

Gets the resource_config of this SddcAllOf. # noqa: E501

Returns

The resource_config of this SddcAllOf. # noqa: E501

Return type

AwsSddcResourceConfig

property sddc_access_state

Gets the sddc_access_state of this SddcAllOf. # noqa: E501

Describes the access state of sddc, valid state is DISABLED or ENABLED # noqa: E501

Returns

The sddc_access_state of this SddcAllOf. # noqa: E501

Return type

str

property sddc_state

Gets the sddc_state of this SddcAllOf. # noqa: E501

Returns

The sddc_state of this SddcAllOf. # noqa: E501

Return type

str

property sddc_type

Gets the sddc_type of this SddcAllOf. # noqa: E501

Type of the sddc # noqa: E501

Returns

The sddc_type of this SddcAllOf. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_allocate_public_ip_spec module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_allocate_public_ip_spec.SddcAllocatePublicIpSpec(count=None, private_ips=None, names=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcAllocatePublicIpSpec - a model defined in OpenAPI

attribute_map = {'count': 'count', 'names': 'names', 'private_ips': 'private_ips'}
property count

Gets the count of this SddcAllocatePublicIpSpec. # noqa: E501

Returns

The count of this SddcAllocatePublicIpSpec. # noqa: E501

Return type

int

property names

Gets the names of this SddcAllocatePublicIpSpec. # noqa: E501

List of names for the workload VM public IP assignment. # noqa: E501

Returns

The names of this SddcAllocatePublicIpSpec. # noqa: E501

Return type

list[str]

openapi_types = {'count': 'int', 'names': 'list[str]', 'private_ips': 'list[str]'}
property private_ips

Gets the private_ips of this SddcAllocatePublicIpSpec. # noqa: E501

List of workload VM private IPs to be assigned the public IP just allocated. # noqa: E501

Returns

The private_ips of this SddcAllocatePublicIpSpec. # noqa: E501

Return type

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_config.SddcConfig(msft_license_config=None, vpc_cidr='10.0.0.0/16', host_instance_type=None, skip_creating_vxlan=None, vxlan_subnet=None, size=None, storage_capacity=None, name=None, account_link_sddc_config=None, sddc_id=None, num_hosts=None, sddc_type=None, account_link_config=None, provider=None, sso_domain='vmc.local', sddc_template_id=None, deployment_type=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcConfig - a model defined in OpenAPI

Gets the account_link_config of this SddcConfig. # noqa: E501

Returns

The account_link_config of this SddcConfig. # noqa: E501

Return type

AccountLinkConfig

Gets the account_link_sddc_config of this SddcConfig. # noqa: E501

A list of the SDDC linking configurations to use. # noqa: E501

Returns

The account_link_sddc_config of this SddcConfig. # noqa: E501

Return type

list[AccountLinkSddcConfig]

attribute_map = {'account_link_config': 'account_link_config', 'account_link_sddc_config': 'account_link_sddc_config', 'deployment_type': 'deployment_type', 'host_instance_type': 'host_instance_type', 'msft_license_config': 'msft_license_config', 'name': 'name', 'num_hosts': 'num_hosts', 'provider': 'provider', 'sddc_id': 'sddc_id', 'sddc_template_id': 'sddc_template_id', 'sddc_type': 'sddc_type', 'size': 'size', 'skip_creating_vxlan': 'skip_creating_vxlan', 'sso_domain': 'sso_domain', 'storage_capacity': 'storage_capacity', 'vpc_cidr': 'vpc_cidr', 'vxlan_subnet': 'vxlan_subnet'}
property deployment_type

Gets the deployment_type of this SddcConfig. # noqa: E501

Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is SingleAZ. # noqa: E501

Returns

The deployment_type of this SddcConfig. # noqa: E501

Return type

str

discriminator_value_class_map = {'AwsSddcConfig': 'AwsSddcConfig'}
get_real_child_model(data)

Returns the real base class specified by the discriminator

property host_instance_type

Gets the host_instance_type of this SddcConfig. # noqa: E501

Returns

The host_instance_type of this SddcConfig. # noqa: E501

Return type

HostInstanceTypes

property msft_license_config

Gets the msft_license_config of this SddcConfig. # noqa: E501

Returns

The msft_license_config of this SddcConfig. # noqa: E501

Return type

MsftLicensingConfig

property name

Gets the name of this SddcConfig. # noqa: E501

Returns

The name of this SddcConfig. # noqa: E501

Return type

str

property num_hosts

Gets the num_hosts of this SddcConfig. # noqa: E501

Returns

The num_hosts of this SddcConfig. # noqa: E501

Return type

int

openapi_types = {'account_link_config': 'AccountLinkConfig', 'account_link_sddc_config': 'list[AccountLinkSddcConfig]', 'deployment_type': 'str', 'host_instance_type': 'HostInstanceTypes', 'msft_license_config': 'MsftLicensingConfig', 'name': 'str', 'num_hosts': 'int', 'provider': 'str', 'sddc_id': 'str', 'sddc_template_id': 'str', 'sddc_type': 'str', 'size': 'str', 'skip_creating_vxlan': 'bool', 'sso_domain': 'str', 'storage_capacity': 'int', 'vpc_cidr': 'str', 'vxlan_subnet': 'str'}
property provider

Gets the provider of this SddcConfig. # noqa: E501

Determines what additional properties are available based on cloud provider. # noqa: E501

Returns

The provider of this SddcConfig. # noqa: E501

Return type

str

property sddc_id

Gets the sddc_id of this SddcConfig. # noqa: E501

If provided, will be assigned as SDDC id of the provisioned SDDC. # noqa: E501

Returns

The sddc_id of this SddcConfig. # noqa: E501

Return type

str

property sddc_template_id

Gets the sddc_template_id of this SddcConfig. # noqa: E501

If provided, configuration from the template will applied to the provisioned SDDC. # noqa: E501

Returns

The sddc_template_id of this SddcConfig. # noqa: E501

Return type

str

property sddc_type

Gets the sddc_type of this SddcConfig. # noqa: E501

Denotes the sddc type , if the value is null or empty, the type is considered as default. # noqa: E501

Returns

The sddc_type of this SddcConfig. # noqa: E501

Return type

str

property size

Gets the size of this SddcConfig. # noqa: E501

The size of the vCenter and NSX appliances. “large” sddcSize corresponds to a ‘large’ vCenter appliance and ‘large’ NSX appliance. ‘medium’ sddcSize corresponds to ‘medium’ vCenter appliance and ‘medium’ NSX appliance. Value defaults to ‘medium’. # noqa: E501

Returns

The size of this SddcConfig. # noqa: E501

Return type

str

property skip_creating_vxlan

Gets the skip_creating_vxlan of this SddcConfig. # noqa: E501

skip creating vxlan for compute gateway for SDDC provisioning # noqa: E501

Returns

The skip_creating_vxlan of this SddcConfig. # noqa: E501

Return type

bool

property sso_domain

Gets the sso_domain of this SddcConfig. # noqa: E501

The SSO domain name to use for vSphere users. If not specified, vmc.local will be used. # noqa: E501

Returns

The sso_domain of this SddcConfig. # noqa: E501

Return type

str

property storage_capacity

Gets the storage_capacity of this SddcConfig. # noqa: E501

The storage capacity value to be requested for the sddc primary cluster, in GiBs. If provided, instead of using the direct-attached storage, a capacity value amount of seperable storage will be used. # noqa: E501

Returns

The storage_capacity of this SddcConfig. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpc_cidr

Gets the vpc_cidr of this SddcConfig. # noqa: E501

AWS VPC IP range. Only prefix of 16 or 20 is currently supported. # noqa: E501

Returns

The vpc_cidr of this SddcConfig. # noqa: E501

Return type

str

property vxlan_subnet

Gets the vxlan_subnet of this SddcConfig. # noqa: E501

VXLAN IP subnet in CIDR for compute gateway # noqa: E501

Returns

The vxlan_subnet of this SddcConfig. # noqa: E501

Return type

str

vmware.vmc.console.models.sddc_config_spec module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_config_spec.SddcConfigSpec(sddc_type_config_spec=None, region_display_names=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcConfigSpec - a model defined in OpenAPI

attribute_map = {'region_display_names': 'region_display_names', 'sddc_type_config_spec': 'sddc_type_config_spec'}
openapi_types = {'region_display_names': 'dict(str, str)', 'sddc_type_config_spec': 'dict(str, ConfigSpec)'}
property region_display_names

Gets the region_display_names of this SddcConfigSpec. # noqa: E501

The region name to display names mapping # noqa: E501

Returns

The region_display_names of this SddcConfigSpec. # noqa: E501

Return type

dict(str, str)

property sddc_type_config_spec

Gets the sddc_type_config_spec of this SddcConfigSpec. # noqa: E501

Map of sddc type to config spec # noqa: E501

Returns

The sddc_type_config_spec of this SddcConfigSpec. # noqa: E501

Return type

dict(str, ConfigSpec)

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_id module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_id.SddcId(sddc_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcId - a model defined in OpenAPI

attribute_map = {'sddc_id': 'sddc_id'}
openapi_types = {'sddc_id': 'str'}
property sddc_id

Gets the sddc_id of this SddcId. # noqa: E501

Sddc ID # noqa: E501

Returns

The sddc_id of this SddcId. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_manifest module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_manifest.SddcManifest(vmc_version=None, glcm_bundle=None, pop_info=None, vmc_internal_version=None, ebs_backed_vsan_config=None, vsan_witness_ami=None, esx_ami=None, esx_nsxt_ami=None, metadata=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcManifest - a model defined in OpenAPI

attribute_map = {'ebs_backed_vsan_config': 'ebs_backed_vsan_config', 'esx_ami': 'esx_ami', 'esx_nsxt_ami': 'esx_nsxt_ami', 'glcm_bundle': 'glcm_bundle', 'metadata': 'metadata', 'pop_info': 'pop_info', 'vmc_internal_version': 'vmc_internal_version', 'vmc_version': 'vmc_version', 'vsan_witness_ami': 'vsan_witness_ami'}
property ebs_backed_vsan_config

Gets the ebs_backed_vsan_config of this SddcManifest. # noqa: E501

Returns

The ebs_backed_vsan_config of this SddcManifest. # noqa: E501

Return type

EbsBackedVsanConfig

property esx_ami

Gets the esx_ami of this SddcManifest. # noqa: E501

Returns

The esx_ami of this SddcManifest. # noqa: E501

Return type

AmiInfo

property esx_nsxt_ami

Gets the esx_nsxt_ami of this SddcManifest. # noqa: E501

Returns

The esx_nsxt_ami of this SddcManifest. # noqa: E501

Return type

AmiInfo

property glcm_bundle

Gets the glcm_bundle of this SddcManifest. # noqa: E501

Returns

The glcm_bundle of this SddcManifest. # noqa: E501

Return type

GlcmBundle

property metadata

Gets the metadata of this SddcManifest. # noqa: E501

Returns

The metadata of this SddcManifest. # noqa: E501

Return type

Metadata

openapi_types = {'ebs_backed_vsan_config': 'EbsBackedVsanConfig', 'esx_ami': 'AmiInfo', 'esx_nsxt_ami': 'AmiInfo', 'glcm_bundle': 'GlcmBundle', 'metadata': 'Metadata', 'pop_info': 'PopInfo', 'vmc_internal_version': 'str', 'vmc_version': 'str', 'vsan_witness_ami': 'AmiInfo'}
property pop_info

Gets the pop_info of this SddcManifest. # noqa: E501

Returns

The pop_info of this SddcManifest. # noqa: E501

Return type

PopInfo

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vmc_internal_version

Gets the vmc_internal_version of this SddcManifest. # noqa: E501

the vmcInternalVersion of the sddc for internal use # noqa: E501

Returns

The vmc_internal_version of this SddcManifest. # noqa: E501

Return type

str

property vmc_version

Gets the vmc_version of this SddcManifest. # noqa: E501

the vmcVersion of the sddc for display # noqa: E501

Returns

The vmc_version of this SddcManifest. # noqa: E501

Return type

str

property vsan_witness_ami

Gets the vsan_witness_ami of this SddcManifest. # noqa: E501

Returns

The vsan_witness_ami of this SddcManifest. # noqa: E501

Return type

AmiInfo

vmware.vmc.console.models.sddc_network module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_network.SddcNetwork(subnets=None, cgw_name=None, name=None, l2_extension=None, cgw_id=None, dhcp_configs=None, id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcNetwork - a model defined in OpenAPI

attribute_map = {'cgw_id': 'cgwId', 'cgw_name': 'cgwName', 'dhcp_configs': 'dhcpConfigs', 'id': 'id', 'l2_extension': 'l2Extension', 'name': 'name', 'subnets': 'subnets'}
property cgw_id

Gets the cgw_id of this SddcNetwork. # noqa: E501

ID of the compute gateway edge to which the logical network is attached. # noqa: E501

Returns

The cgw_id of this SddcNetwork. # noqa: E501

Return type

str

property cgw_name

Gets the cgw_name of this SddcNetwork. # noqa: E501

Name of the compute gateway to which the logical network is attached. # noqa: E501

Returns

The cgw_name of this SddcNetwork. # noqa: E501

Return type

str

property dhcp_configs

Gets the dhcp_configs of this SddcNetwork. # noqa: E501

Returns

The dhcp_configs of this SddcNetwork. # noqa: E501

Return type

SddcNetworkDhcpConfig

property id

Gets the id of this SddcNetwork. # noqa: E501

ID of logical network. # noqa: E501

Returns

The id of this SddcNetwork. # noqa: E501

Return type

str

property l2_extension

Gets the l2_extension of this SddcNetwork. # noqa: E501

Returns

The l2_extension of this SddcNetwork. # noqa: E501

Return type

L2Extension

property name

Gets the name of this SddcNetwork. # noqa: E501

Name of logical network. Length needs to be between 1-35 characters. # noqa: E501

Returns

The name of this SddcNetwork. # noqa: E501

Return type

str

openapi_types = {'cgw_id': 'str', 'cgw_name': 'str', 'dhcp_configs': 'SddcNetworkDhcpConfig', 'id': 'str', 'l2_extension': 'L2Extension', 'name': 'str', 'subnets': 'SddcNetworkAddressGroups'}
property subnets

Gets the subnets of this SddcNetwork. # noqa: E501

Returns

The subnets of this SddcNetwork. # noqa: E501

Return type

SddcNetworkAddressGroups

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_network_address_group module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_network_address_group.SddcNetworkAddressGroup(prefix_length=None, primary_address=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcNetworkAddressGroup - a model defined in OpenAPI

attribute_map = {'prefix_length': 'prefixLength', 'primary_address': 'primaryAddress'}
openapi_types = {'prefix_length': 'str', 'primary_address': 'str'}
property prefix_length

Gets the prefix_length of this SddcNetworkAddressGroup. # noqa: E501

Prefix length of logical network. # noqa: E501

Returns

The prefix_length of this SddcNetworkAddressGroup. # noqa: E501

Return type

str

property primary_address

Gets the primary_address of this SddcNetworkAddressGroup. # noqa: E501

Primary address for logical network. # noqa: E501

Returns

The primary_address of this SddcNetworkAddressGroup. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_network_address_groups module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_network_address_groups.SddcNetworkAddressGroups(address_groups=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcNetworkAddressGroups - a model defined in OpenAPI

property address_groups

Gets the address_groups of this SddcNetworkAddressGroups. # noqa: E501

List of logical network address groups. # noqa: E501

Returns

The address_groups of this SddcNetworkAddressGroups. # noqa: E501

Return type

list[SddcNetworkAddressGroup]

attribute_map = {'address_groups': 'addressGroups'}
openapi_types = {'address_groups': 'list[SddcNetworkAddressGroup]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_network_dhcp_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_network_dhcp_config.SddcNetworkDhcpConfig(ip_pools=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcNetworkDhcpConfig - a model defined in OpenAPI

attribute_map = {'ip_pools': 'ipPools'}
property ip_pools

Gets the ip_pools of this SddcNetworkDhcpConfig. # noqa: E501

List of IP pools in DHCP configuration. # noqa: E501

Returns

The ip_pools of this SddcNetworkDhcpConfig. # noqa: E501

Return type

list[SddcNetworkDhcpIpPool]

openapi_types = {'ip_pools': 'list[SddcNetworkDhcpIpPool]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_network_dhcp_ip_pool module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_network_dhcp_ip_pool.SddcNetworkDhcpIpPool(ip_range=None, domain_name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcNetworkDhcpIpPool - a model defined in OpenAPI

attribute_map = {'domain_name': 'domainName', 'ip_range': 'ipRange'}
property domain_name

Gets the domain_name of this SddcNetworkDhcpIpPool. # noqa: E501

DNS domain name. # noqa: E501

Returns

The domain_name of this SddcNetworkDhcpIpPool. # noqa: E501

Return type

str

property ip_range

Gets the ip_range of this SddcNetworkDhcpIpPool. # noqa: E501

IP range for DHCP IP pool. # noqa: E501

Returns

The ip_range of this SddcNetworkDhcpIpPool. # noqa: E501

Return type

str

openapi_types = {'domain_name': 'str', 'ip_range': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_patch_request module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_patch_request.SddcPatchRequest(name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcPatchRequest - a model defined in OpenAPI

attribute_map = {'name': 'name'}
property name

Gets the name of this SddcPatchRequest. # noqa: E501

The new name of the SDDC to be changed to. # noqa: E501

Returns

The name of this SddcPatchRequest. # noqa: E501

Return type

str

openapi_types = {'name': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_public_ip module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_public_ip.SddcPublicIp(public_ip=None, name=None, allocation_id=None, dnat_rule_id=None, associated_private_ip=None, snat_rule_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcPublicIp - a model defined in OpenAPI

property allocation_id

Gets the allocation_id of this SddcPublicIp. # noqa: E501

Returns

The allocation_id of this SddcPublicIp. # noqa: E501

Return type

str

property associated_private_ip

Gets the associated_private_ip of this SddcPublicIp. # noqa: E501

Returns

The associated_private_ip of this SddcPublicIp. # noqa: E501

Return type

str

attribute_map = {'allocation_id': 'allocation_id', 'associated_private_ip': 'associated_private_ip', 'dnat_rule_id': 'dnat_rule_id', 'name': 'name', 'public_ip': 'public_ip', 'snat_rule_id': 'snat_rule_id'}
property dnat_rule_id

Gets the dnat_rule_id of this SddcPublicIp. # noqa: E501

Returns

The dnat_rule_id of this SddcPublicIp. # noqa: E501

Return type

str

property name

Gets the name of this SddcPublicIp. # noqa: E501

Returns

The name of this SddcPublicIp. # noqa: E501

Return type

str

openapi_types = {'allocation_id': 'str', 'associated_private_ip': 'str', 'dnat_rule_id': 'str', 'name': 'str', 'public_ip': 'str', 'snat_rule_id': 'str'}
property public_ip

Gets the public_ip of this SddcPublicIp. # noqa: E501

Returns

The public_ip of this SddcPublicIp. # noqa: E501

Return type

str

property snat_rule_id

Gets the snat_rule_id of this SddcPublicIp. # noqa: E501

Returns

The snat_rule_id of this SddcPublicIp. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_resource_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_resource_config.SddcResourceConfig(mgmt_appliance_network_name=None, nsxt=None, mgw_id=None, nsx_mgr_url=None, psc_management_ip=None, psc_url=None, cgws=None, availability_zones=None, management_ds=None, nsx_api_public_endpoint_url=None, custom_properties=None, cloud_password=None, provider=None, clusters=None, vc_management_ip=None, sddc_networks=None, cloud_username=None, esx_hosts=None, nsx_mgr_management_ip=None, vc_instance_id=None, esx_cluster_id=None, vc_public_ip=None, skip_creating_vxlan=None, vc_url=None, sddc_manifest=None, vxlan_subnet=None, cloud_user_group=None, management_rp=None, region=None, witness_availability_zone=None, sddc_id=None, pop_agent_xeni_connection=None, sddc_size=None, nsx_controller_ips=None, esx_host_subnet=None, sso_domain=None, deployment_type=None, msft_license_config=None, nsxt_addons=None, dns_with_management_vm_private_ip=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcResourceConfig - a model defined in OpenAPI

attribute_map = {'availability_zones': 'availability_zones', 'cgws': 'cgws', 'cloud_password': 'cloud_password', 'cloud_user_group': 'cloud_user_group', 'cloud_username': 'cloud_username', 'clusters': 'clusters', 'custom_properties': 'custom_properties', 'deployment_type': 'deployment_type', 'dns_with_management_vm_private_ip': 'dns_with_management_vm_private_ip', 'esx_cluster_id': 'esx_cluster_id', 'esx_host_subnet': 'esx_host_subnet', 'esx_hosts': 'esx_hosts', 'management_ds': 'management_ds', 'management_rp': 'management_rp', 'mgmt_appliance_network_name': 'mgmt_appliance_network_name', 'mgw_id': 'mgw_id', 'msft_license_config': 'msft_license_config', 'nsx_api_public_endpoint_url': 'nsx_api_public_endpoint_url', 'nsx_controller_ips': 'nsx_controller_ips', 'nsx_mgr_management_ip': 'nsx_mgr_management_ip', 'nsx_mgr_url': 'nsx_mgr_url', 'nsxt': 'nsxt', 'nsxt_addons': 'nsxt_addons', 'pop_agent_xeni_connection': 'pop_agent_xeni_connection', 'provider': 'provider', 'psc_management_ip': 'psc_management_ip', 'psc_url': 'psc_url', 'region': 'region', 'sddc_id': 'sddc_id', 'sddc_manifest': 'sddc_manifest', 'sddc_networks': 'sddc_networks', 'sddc_size': 'sddc_size', 'skip_creating_vxlan': 'skip_creating_vxlan', 'sso_domain': 'sso_domain', 'vc_instance_id': 'vc_instance_id', 'vc_management_ip': 'vc_management_ip', 'vc_public_ip': 'vc_public_ip', 'vc_url': 'vc_url', 'vxlan_subnet': 'vxlan_subnet', 'witness_availability_zone': 'witness_availability_zone'}
property availability_zones

Gets the availability_zones of this SddcResourceConfig. # noqa: E501

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. # noqa: E501

Returns

The availability_zones of this SddcResourceConfig. # noqa: E501

Return type

list[str]

property cgws

Gets the cgws of this SddcResourceConfig. # noqa: E501

Returns

The cgws of this SddcResourceConfig. # noqa: E501

Return type

list[str]

property cloud_password

Gets the cloud_password of this SddcResourceConfig. # noqa: E501

Password for vCenter SDDC administrator # noqa: E501

Returns

The cloud_password of this SddcResourceConfig. # noqa: E501

Return type

str

property cloud_user_group

Gets the cloud_user_group of this SddcResourceConfig. # noqa: E501

Group name for vCenter SDDC administrator # noqa: E501

Returns

The cloud_user_group of this SddcResourceConfig. # noqa: E501

Return type

str

property cloud_username

Gets the cloud_username of this SddcResourceConfig. # noqa: E501

Username for vCenter SDDC administrator # noqa: E501

Returns

The cloud_username of this SddcResourceConfig. # noqa: E501

Return type

str

property clusters

Gets the clusters of this SddcResourceConfig. # noqa: E501

List of clusters in the SDDC. # noqa: E501

Returns

The clusters of this SddcResourceConfig. # noqa: E501

Return type

list[Cluster]

property custom_properties

Gets the custom_properties of this SddcResourceConfig. # noqa: E501

Returns

The custom_properties of this SddcResourceConfig. # noqa: E501

Return type

dict(str, str)

property deployment_type

Gets the deployment_type of this SddcResourceConfig. # noqa: E501

Denotes if this is a SingleAZ SDDC or a MultiAZ SDDC. # noqa: E501

Returns

The deployment_type of this SddcResourceConfig. # noqa: E501

Return type

str

discriminator_value_class_map = {'AwsSddcResourceConfig': 'AwsSddcResourceConfig'}
property dns_with_management_vm_private_ip

Gets the dns_with_management_vm_private_ip of this SddcResourceConfig. # noqa: E501

if true, use the private IP addresses to register DNS records for the management VMs # noqa: E501

Returns

The dns_with_management_vm_private_ip of this SddcResourceConfig. # noqa: E501

Return type

bool

property esx_cluster_id

Gets the esx_cluster_id of this SddcResourceConfig. # noqa: E501

Cluster Id to add ESX workflow # noqa: E501

Returns

The esx_cluster_id of this SddcResourceConfig. # noqa: E501

Return type

str

property esx_host_subnet

Gets the esx_host_subnet of this SddcResourceConfig. # noqa: E501

ESX host subnet # noqa: E501

Returns

The esx_host_subnet of this SddcResourceConfig. # noqa: E501

Return type

str

property esx_hosts

Gets the esx_hosts of this SddcResourceConfig. # noqa: E501

Returns

The esx_hosts of this SddcResourceConfig. # noqa: E501

Return type

list[AwsEsxHost]

get_real_child_model(data)

Returns the real base class specified by the discriminator

property management_ds

Gets the management_ds of this SddcResourceConfig. # noqa: E501

The ManagedObjectReference of the management Datastore # noqa: E501

Returns

The management_ds of this SddcResourceConfig. # noqa: E501

Return type

str

property management_rp

Gets the management_rp of this SddcResourceConfig. # noqa: E501

Returns

The management_rp of this SddcResourceConfig. # noqa: E501

Return type

str

property mgmt_appliance_network_name

Gets the mgmt_appliance_network_name of this SddcResourceConfig. # noqa: E501

Name for management appliance network. # noqa: E501

Returns

The mgmt_appliance_network_name of this SddcResourceConfig. # noqa: E501

Return type

str

property mgw_id

Gets the mgw_id of this SddcResourceConfig. # noqa: E501

Management Gateway Id # noqa: E501

Returns

The mgw_id of this SddcResourceConfig. # noqa: E501

Return type

str

property msft_license_config

Gets the msft_license_config of this SddcResourceConfig. # noqa: E501

Returns

The msft_license_config of this SddcResourceConfig. # noqa: E501

Return type

MsftLicensingConfig

property nsx_api_public_endpoint_url

Gets the nsx_api_public_endpoint_url of this SddcResourceConfig. # noqa: E501

nsx api entire base url # noqa: E501

Returns

The nsx_api_public_endpoint_url of this SddcResourceConfig. # noqa: E501

Return type

str

property nsx_controller_ips

Gets the nsx_controller_ips of this SddcResourceConfig. # noqa: E501

List of Controller IPs # noqa: E501

Returns

The nsx_controller_ips of this SddcResourceConfig. # noqa: E501

Return type

list[str]

property nsx_mgr_management_ip

Gets the nsx_mgr_management_ip of this SddcResourceConfig. # noqa: E501

NSX Manager internal management IP # noqa: E501

Returns

The nsx_mgr_management_ip of this SddcResourceConfig. # noqa: E501

Return type

str

property nsx_mgr_url

Gets the nsx_mgr_url of this SddcResourceConfig. # noqa: E501

URL of the NSX Manager # noqa: E501

Returns

The nsx_mgr_url of this SddcResourceConfig. # noqa: E501

Return type

str

property nsxt

Gets the nsxt of this SddcResourceConfig. # noqa: E501

if true, NSX-T UI is enabled. # noqa: E501

Returns

The nsxt of this SddcResourceConfig. # noqa: E501

Return type

bool

property nsxt_addons

Gets the nsxt_addons of this SddcResourceConfig. # noqa: E501

Returns

The nsxt_addons of this SddcResourceConfig. # noqa: E501

Return type

NsxtAddons

openapi_types = {'availability_zones': 'list[str]', 'cgws': 'list[str]', 'cloud_password': 'str', 'cloud_user_group': 'str', 'cloud_username': 'str', 'clusters': 'list[Cluster]', 'custom_properties': 'dict(str, str)', 'deployment_type': 'str', 'dns_with_management_vm_private_ip': 'bool', 'esx_cluster_id': 'str', 'esx_host_subnet': 'str', 'esx_hosts': 'list[AwsEsxHost]', 'management_ds': 'str', 'management_rp': 'str', 'mgmt_appliance_network_name': 'str', 'mgw_id': 'str', 'msft_license_config': 'MsftLicensingConfig', 'nsx_api_public_endpoint_url': 'str', 'nsx_controller_ips': 'list[str]', 'nsx_mgr_management_ip': 'str', 'nsx_mgr_url': 'str', 'nsxt': 'bool', 'nsxt_addons': 'NsxtAddons', 'pop_agent_xeni_connection': 'PopAgentXeniConnection', 'provider': 'str', 'psc_management_ip': 'str', 'psc_url': 'str', 'region': 'str', 'sddc_id': 'str', 'sddc_manifest': 'SddcManifest', 'sddc_networks': 'list[str]', 'sddc_size': 'SddcSize', 'skip_creating_vxlan': 'bool', 'sso_domain': 'str', 'vc_instance_id': 'str', 'vc_management_ip': 'str', 'vc_public_ip': 'str', 'vc_url': 'str', 'vxlan_subnet': 'str', 'witness_availability_zone': 'str'}
property pop_agent_xeni_connection

Gets the pop_agent_xeni_connection of this SddcResourceConfig. # noqa: E501

Returns

The pop_agent_xeni_connection of this SddcResourceConfig. # noqa: E501

Return type

PopAgentXeniConnection

property provider

Gets the provider of this SddcResourceConfig. # noqa: E501

Discriminator for additional properties # noqa: E501

Returns

The provider of this SddcResourceConfig. # noqa: E501

Return type

str

property psc_management_ip

Gets the psc_management_ip of this SddcResourceConfig. # noqa: E501

PSC internal management IP # noqa: E501

Returns

The psc_management_ip of this SddcResourceConfig. # noqa: E501

Return type

str

property psc_url

Gets the psc_url of this SddcResourceConfig. # noqa: E501

URL of the PSC server # noqa: E501

Returns

The psc_url of this SddcResourceConfig. # noqa: E501

Return type

str

property region

Gets the region of this SddcResourceConfig. # noqa: E501

region in which sddc is deployed # noqa: E501

Returns

The region of this SddcResourceConfig. # noqa: E501

Return type

str

property sddc_id

Gets the sddc_id of this SddcResourceConfig. # noqa: E501

sddc identifier # noqa: E501

Returns

The sddc_id of this SddcResourceConfig. # noqa: E501

Return type

str

property sddc_manifest

Gets the sddc_manifest of this SddcResourceConfig. # noqa: E501

Returns

The sddc_manifest of this SddcResourceConfig. # noqa: E501

Return type

SddcManifest

property sddc_networks

Gets the sddc_networks of this SddcResourceConfig. # noqa: E501

Returns

The sddc_networks of this SddcResourceConfig. # noqa: E501

Return type

list[str]

property sddc_size

Gets the sddc_size of this SddcResourceConfig. # noqa: E501

Returns

The sddc_size of this SddcResourceConfig. # noqa: E501

Return type

SddcSize

property skip_creating_vxlan

Gets the skip_creating_vxlan of this SddcResourceConfig. # noqa: E501

skip creating vxlan for compute gateway for SDDC provisioning # noqa: E501

Returns

The skip_creating_vxlan of this SddcResourceConfig. # noqa: E501

Return type

bool

property sso_domain

Gets the sso_domain of this SddcResourceConfig. # noqa: E501

The SSO domain name to use for vSphere users # noqa: E501

Returns

The sso_domain of this SddcResourceConfig. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vc_instance_id

Gets the vc_instance_id of this SddcResourceConfig. # noqa: E501

unique id of the vCenter server # noqa: E501

Returns

The vc_instance_id of this SddcResourceConfig. # noqa: E501

Return type

str

property vc_management_ip

Gets the vc_management_ip of this SddcResourceConfig. # noqa: E501

vCenter internal management IP # noqa: E501

Returns

The vc_management_ip of this SddcResourceConfig. # noqa: E501

Return type

str

property vc_public_ip

Gets the vc_public_ip of this SddcResourceConfig. # noqa: E501

vCenter public IP # noqa: E501

Returns

The vc_public_ip of this SddcResourceConfig. # noqa: E501

Return type

str

property vc_url

Gets the vc_url of this SddcResourceConfig. # noqa: E501

URL of the vCenter server # noqa: E501

Returns

The vc_url of this SddcResourceConfig. # noqa: E501

Return type

str

property vxlan_subnet

Gets the vxlan_subnet of this SddcResourceConfig. # noqa: E501

VXLAN IP subnet # noqa: E501

Returns

The vxlan_subnet of this SddcResourceConfig. # noqa: E501

Return type

str

property witness_availability_zone

Gets the witness_availability_zone of this SddcResourceConfig. # noqa: E501

Availability zone where the witness node is provisioned for a MultiAZ SDDC. This is null for a SingleAZ SDDC. # noqa: E501

Returns

The witness_availability_zone of this SddcResourceConfig. # noqa: E501

Return type

str

vmware.vmc.console.models.sddc_size module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_size.SddcSize(vc_size=None, nsx_size=None, size=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcSize - a model defined in OpenAPI

attribute_map = {'nsx_size': 'nsx_size', 'size': 'size', 'vc_size': 'vc_size'}
property nsx_size

Gets the nsx_size of this SddcSize. # noqa: E501

Returns

The nsx_size of this SddcSize. # noqa: E501

Return type

str

openapi_types = {'nsx_size': 'str', 'size': 'str', 'vc_size': 'str'}
property size

Gets the size of this SddcSize. # noqa: E501

Returns

The size of this SddcSize. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vc_size

Gets the vc_size of this SddcSize. # noqa: E501

Returns

The vc_size of this SddcSize. # noqa: E501

Return type

str

vmware.vmc.console.models.sddc_state_request module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_state_request.SddcStateRequest(sddcs=None, states=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcStateRequest - a model defined in OpenAPI

attribute_map = {'sddcs': 'sddcs', 'states': 'states'}
openapi_types = {'sddcs': 'list[str]', 'states': 'list[str]'}
property sddcs

Gets the sddcs of this SddcStateRequest. # noqa: E501

Returns

The sddcs of this SddcStateRequest. # noqa: E501

Return type

list[str]

property states

Gets the states of this SddcStateRequest. # noqa: E501

Returns

The states of this SddcStateRequest. # noqa: E501

Return type

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sddc_template module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_template.SddcTemplate(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, account_link_sddc_configs=None, state=None, network_template=None, name=None, source_sddc_id=None, org_id=None, sddc=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcTemplate - a model defined in OpenAPI

Gets the account_link_sddc_configs of this SddcTemplate. # noqa: E501

A list of the SDDC linking configurations to use. # noqa: E501

Returns

The account_link_sddc_configs of this SddcTemplate. # noqa: E501

Return type

list[AccountLinkSddcConfig]

attribute_map = {'account_link_sddc_configs': 'account_link_sddc_configs', 'created': 'created', 'id': 'id', 'name': 'name', 'network_template': 'network_template', 'org_id': 'org_id', 'sddc': 'sddc', 'source_sddc_id': 'source_sddc_id', 'state': 'state', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version'}
property created

Gets the created of this SddcTemplate. # noqa: E501

Returns

The created of this SddcTemplate. # noqa: E501

Return type

datetime

property id

Gets the id of this SddcTemplate. # noqa: E501

Unique ID for this entity # noqa: E501

Returns

The id of this SddcTemplate. # noqa: E501

Return type

str

property name

Gets the name of this SddcTemplate. # noqa: E501

name for SDDC configuration template # noqa: E501

Returns

The name of this SddcTemplate. # noqa: E501

Return type

str

property network_template

Gets the network_template of this SddcTemplate. # noqa: E501

Returns

The network_template of this SddcTemplate. # noqa: E501

Return type

NetworkTemplate

openapi_types = {'account_link_sddc_configs': 'list[AccountLinkSddcConfig]', 'created': 'datetime', 'id': 'str', 'name': 'str', 'network_template': 'NetworkTemplate', 'org_id': 'str', 'sddc': 'Sddc', 'source_sddc_id': 'str', 'state': 'str', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int'}
property org_id

Gets the org_id of this SddcTemplate. # noqa: E501

Returns

The org_id of this SddcTemplate. # noqa: E501

Return type

str

property sddc

Gets the sddc of this SddcTemplate. # noqa: E501

Returns

The sddc of this SddcTemplate. # noqa: E501

Return type

Sddc

property source_sddc_id

Gets the source_sddc_id of this SddcTemplate. # noqa: E501

Returns

The source_sddc_id of this SddcTemplate. # noqa: E501

Return type

str

property state

Gets the state of this SddcTemplate. # noqa: E501

Returns

The state of this SddcTemplate. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property updated

Gets the updated of this SddcTemplate. # noqa: E501

Returns

The updated of this SddcTemplate. # noqa: E501

Return type

datetime

property updated_by_user_id

Gets the updated_by_user_id of this SddcTemplate. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The updated_by_user_id of this SddcTemplate. # noqa: E501

Return type

str

property updated_by_user_name

Gets the updated_by_user_name of this SddcTemplate. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The updated_by_user_name of this SddcTemplate. # noqa: E501

Return type

str

property user_id

Gets the user_id of this SddcTemplate. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The user_id of this SddcTemplate. # noqa: E501

Return type

str

property user_name

Gets the user_name of this SddcTemplate. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The user_name of this SddcTemplate. # noqa: E501

Return type

str

property version

Gets the version of this SddcTemplate. # noqa: E501

Version of this entity # noqa: E501

Returns

The version of this SddcTemplate. # noqa: E501

Return type

int

vmware.vmc.console.models.sddc_template_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sddc_template_all_of.SddcTemplateAllOf(account_link_sddc_configs=None, state=None, network_template=None, name=None, source_sddc_id=None, org_id=None, sddc=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SddcTemplateAllOf - a model defined in OpenAPI

Gets the account_link_sddc_configs of this SddcTemplateAllOf. # noqa: E501

A list of the SDDC linking configurations to use. # noqa: E501

Returns

The account_link_sddc_configs of this SddcTemplateAllOf. # noqa: E501

Return type

list[AccountLinkSddcConfig]

attribute_map = {'account_link_sddc_configs': 'account_link_sddc_configs', 'name': 'name', 'network_template': 'network_template', 'org_id': 'org_id', 'sddc': 'sddc', 'source_sddc_id': 'source_sddc_id', 'state': 'state'}
property name

Gets the name of this SddcTemplateAllOf. # noqa: E501

name for SDDC configuration template # noqa: E501

Returns

The name of this SddcTemplateAllOf. # noqa: E501

Return type

str

property network_template

Gets the network_template of this SddcTemplateAllOf. # noqa: E501

Returns

The network_template of this SddcTemplateAllOf. # noqa: E501

Return type

NetworkTemplate

openapi_types = {'account_link_sddc_configs': 'list[AccountLinkSddcConfig]', 'name': 'str', 'network_template': 'NetworkTemplate', 'org_id': 'str', 'sddc': 'Sddc', 'source_sddc_id': 'str', 'state': 'str'}
property org_id

Gets the org_id of this SddcTemplateAllOf. # noqa: E501

Returns

The org_id of this SddcTemplateAllOf. # noqa: E501

Return type

str

property sddc

Gets the sddc of this SddcTemplateAllOf. # noqa: E501

Returns

The sddc of this SddcTemplateAllOf. # noqa: E501

Return type

Sddc

property source_sddc_id

Gets the source_sddc_id of this SddcTemplateAllOf. # noqa: E501

Returns

The source_sddc_id of this SddcTemplateAllOf. # noqa: E501

Return type

str

property state

Gets the state of this SddcTemplateAllOf. # noqa: E501

Returns

The state of this SddcTemplateAllOf. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.secondary_addresses module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.secondary_addresses.SecondaryAddresses(type=None, ip_address=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SecondaryAddresses - a model defined in OpenAPI

attribute_map = {'ip_address': 'ipAddress', 'type': 'type'}
property ip_address

Gets the ip_address of this SecondaryAddresses. # noqa: E501

List of IP addresses. # noqa: E501

Returns

The ip_address of this SecondaryAddresses. # noqa: E501

Return type

list[str]

openapi_types = {'ip_address': 'list[str]', 'type': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this SecondaryAddresses. # noqa: E501

Returns

The type of this SecondaryAddresses. # noqa: E501

Return type

str

vmware.vmc.console.models.service_error module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.service_error.ServiceError(default_message=None, original_service=None, localized_message=None, original_service_error_code=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

ServiceError - a model defined in OpenAPI

attribute_map = {'default_message': 'default_message', 'localized_message': 'localized_message', 'original_service': 'original_service', 'original_service_error_code': 'original_service_error_code'}
property default_message

Gets the default_message of this ServiceError. # noqa: E501

Error message in English. # noqa: E501

Returns

The default_message of this ServiceError. # noqa: E501

Return type

str

property localized_message

Gets the localized_message of this ServiceError. # noqa: E501

The localized message. # noqa: E501

Returns

The localized_message of this ServiceError. # noqa: E501

Return type

str

openapi_types = {'default_message': 'str', 'localized_message': 'str', 'original_service': 'str', 'original_service_error_code': 'str'}
property original_service

Gets the original_service of this ServiceError. # noqa: E501

The original service name of the error. # noqa: E501

Returns

The original_service of this ServiceError. # noqa: E501

Return type

str

property original_service_error_code

Gets the original_service_error_code of this ServiceError. # noqa: E501

The original error code of the service. # noqa: E501

Returns

The original_service_error_code of this ServiceError. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.site module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.site.Site(password=None, user_id=None, name=None, rx_bytes_on_local_subnet=None, secure_traffic=None, established_date=None, failure_message=None, dropped_tx_packets=None, dropped_rx_packets=None, tunnel_status=None, tx_bytes_from_local_subnet=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Site - a model defined in OpenAPI

attribute_map = {'dropped_rx_packets': 'dropped_rx_packets', 'dropped_tx_packets': 'dropped_tx_packets', 'established_date': 'established_date', 'failure_message': 'failure_message', 'name': 'name', 'password': 'password', 'rx_bytes_on_local_subnet': 'rx_bytes_on_local_subnet', 'secure_traffic': 'secure_traffic', 'tunnel_status': 'tunnel_status', 'tx_bytes_from_local_subnet': 'tx_bytes_from_local_subnet', 'user_id': 'user_id'}
property dropped_rx_packets

Gets the dropped_rx_packets of this Site. # noqa: E501

Number of received packets dropped. # noqa: E501

Returns

The dropped_rx_packets of this Site. # noqa: E501

Return type

str

property dropped_tx_packets

Gets the dropped_tx_packets of this Site. # noqa: E501

Number of transmitted packets dropped. # noqa: E501

Returns

The dropped_tx_packets of this Site. # noqa: E501

Return type

str

property established_date

Gets the established_date of this Site. # noqa: E501

Date tunnel was established. # noqa: E501

Returns

The established_date of this Site. # noqa: E501

Return type

str

property failure_message

Gets the failure_message of this Site. # noqa: E501

failure message. # noqa: E501

Returns

The failure_message of this Site. # noqa: E501

Return type

str

property name

Gets the name of this Site. # noqa: E501

Unique name for the site getting configured. # noqa: E501

Returns

The name of this Site. # noqa: E501

Return type

str

openapi_types = {'dropped_rx_packets': 'str', 'dropped_tx_packets': 'str', 'established_date': 'str', 'failure_message': 'str', 'name': 'str', 'password': 'str', 'rx_bytes_on_local_subnet': 'int', 'secure_traffic': 'bool', 'tunnel_status': 'str', 'tx_bytes_from_local_subnet': 'int', 'user_id': 'str'}
property password

Gets the password of this Site. # noqa: E501

Site password. # noqa: E501

Returns

The password of this Site. # noqa: E501

Return type

str

property rx_bytes_on_local_subnet

Gets the rx_bytes_on_local_subnet of this Site. # noqa: E501

Bytes received on local network. # noqa: E501

Returns

The rx_bytes_on_local_subnet of this Site. # noqa: E501

Return type

int

property secure_traffic

Gets the secure_traffic of this Site. # noqa: E501

Enable/disable encription. # noqa: E501

Returns

The secure_traffic of this Site. # noqa: E501

Return type

bool

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tunnel_status

Gets the tunnel_status of this Site. # noqa: E501

Site tunnel status. # noqa: E501

Returns

The tunnel_status of this Site. # noqa: E501

Return type

str

property tx_bytes_from_local_subnet

Gets the tx_bytes_from_local_subnet of this Site. # noqa: E501

Bytes transmitted from local subnet. # noqa: E501

Returns

The tx_bytes_from_local_subnet of this Site. # noqa: E501

Return type

int

property user_id

Gets the user_id of this Site. # noqa: E501

Site user id. # noqa: E501

Returns

The user_id of this Site. # noqa: E501

Return type

str

vmware.vmc.console.models.sites module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sites.Sites(sites=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Sites - a model defined in OpenAPI

attribute_map = {'sites': 'sites'}
openapi_types = {'sites': 'list[Nsxsite]'}
property sites

Gets the sites of this Sites. # noqa: E501

Returns

The sites of this Sites. # noqa: E501

Return type

list[Nsxsite]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sslvpn_dashboard_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sslvpn_dashboard_stats.SslvpnDashboardStats(active_clients=None, sslvpn_bytes_in=None, auth_failures=None, sessions_created=None, sslvpn_bytes_out=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SslvpnDashboardStats - a model defined in OpenAPI

property active_clients

Gets the active_clients of this SslvpnDashboardStats. # noqa: E501

Number of active clients. # noqa: E501

Returns

The active_clients of this SslvpnDashboardStats. # noqa: E501

Return type

list[DashboardStat]

attribute_map = {'active_clients': 'activeClients', 'auth_failures': 'authFailures', 'sessions_created': 'sessionsCreated', 'sslvpn_bytes_in': 'sslvpnBytesIn', 'sslvpn_bytes_out': 'sslvpnBytesOut'}
property auth_failures

Gets the auth_failures of this SslvpnDashboardStats. # noqa: E501

Number of authentication failures. # noqa: E501

Returns

The auth_failures of this SslvpnDashboardStats. # noqa: E501

Return type

list[DashboardStat]

openapi_types = {'active_clients': 'list[DashboardStat]', 'auth_failures': 'list[DashboardStat]', 'sessions_created': 'list[DashboardStat]', 'sslvpn_bytes_in': 'list[DashboardStat]', 'sslvpn_bytes_out': 'list[DashboardStat]'}
property sessions_created

Gets the sessions_created of this SslvpnDashboardStats. # noqa: E501

Number of SSL VPN sessions created. # noqa: E501

Returns

The sessions_created of this SslvpnDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property sslvpn_bytes_in

Gets the sslvpn_bytes_in of this SslvpnDashboardStats. # noqa: E501

Rx bytes received for SSL VPN. # noqa: E501

Returns

The sslvpn_bytes_in of this SslvpnDashboardStats. # noqa: E501

Return type

list[DashboardStat]

property sslvpn_bytes_out

Gets the sslvpn_bytes_out of this SslvpnDashboardStats. # noqa: E501

Tx bytes transmitted for SSL VPN. # noqa: E501

Returns

The sslvpn_bytes_out of this SslvpnDashboardStats. # noqa: E501

Return type

list[DashboardStat]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.sub_interface module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sub_interface.SubInterface(index=None, tunnel_id=None, name=None, address_groups=None, vlan_id=None, label=None, logical_switch_name=None, is_connected=None, mtu=None, logical_switch_id=None, enable_send_redirects=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SubInterface - a model defined in OpenAPI

property address_groups

Gets the address_groups of this SubInterface. # noqa: E501

Returns

The address_groups of this SubInterface. # noqa: E501

Return type

EdgeVnicAddressGroups

attribute_map = {'address_groups': 'addressGroups', 'enable_send_redirects': 'enableSendRedirects', 'index': 'index', 'is_connected': 'isConnected', 'label': 'label', 'logical_switch_id': 'logicalSwitchId', 'logical_switch_name': 'logicalSwitchName', 'mtu': 'mtu', 'name': 'name', 'tunnel_id': 'tunnelId', 'vlan_id': 'vlanId'}
property enable_send_redirects

Gets the enable_send_redirects of this SubInterface. # noqa: E501

Value is true if send redirects is enabled. Enable ICMP redirect to convey routing information to hosts. # noqa: E501

Returns

The enable_send_redirects of this SubInterface. # noqa: E501

Return type

bool

property index

Gets the index of this SubInterface. # noqa: E501

Index of the sub interface assigned by NSX Manager. Min value is 10 and max value is 4103. # noqa: E501

Returns

The index of this SubInterface. # noqa: E501

Return type

int

property is_connected

Gets the is_connected of this SubInterface. # noqa: E501

Value is true if the sub interface is connected to a logical switch, standard portgroup or distributed portgroup. # noqa: E501

Returns

The is_connected of this SubInterface. # noqa: E501

Return type

bool

property label

Gets the label of this SubInterface. # noqa: E501

Sub interface label of format vNic_{index} provided by NSX Manager. Read only. # noqa: E501

Returns

The label of this SubInterface. # noqa: E501

Return type

str

property logical_switch_id

Gets the logical_switch_id of this SubInterface. # noqa: E501

ID of the logical switch connected to this sub interface. # noqa: E501

Returns

The logical_switch_id of this SubInterface. # noqa: E501

Return type

str

property logical_switch_name

Gets the logical_switch_name of this SubInterface. # noqa: E501

Name of the logical switch connected to this sub interface. # noqa: E501

Returns

The logical_switch_name of this SubInterface. # noqa: E501

Return type

str

property mtu

Gets the mtu of this SubInterface. # noqa: E501

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. # noqa: E501

Returns

The mtu of this SubInterface. # noqa: E501

Return type

int

property name

Gets the name of this SubInterface. # noqa: E501

Name of the sub interface. Required. # noqa: E501

Returns

The name of this SubInterface. # noqa: E501

Return type

str

openapi_types = {'address_groups': 'EdgeVnicAddressGroups', 'enable_send_redirects': 'bool', 'index': 'int', 'is_connected': 'bool', 'label': 'str', 'logical_switch_id': 'str', 'logical_switch_name': 'str', 'mtu': 'int', 'name': 'str', 'tunnel_id': 'int', 'vlan_id': 'int'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tunnel_id

Gets the tunnel_id of this SubInterface. # noqa: E501

Valid values for tunnel ID are min 1 to max 4093. Required. # noqa: E501

Returns

The tunnel_id of this SubInterface. # noqa: E501

Return type

int

property vlan_id

Gets the vlan_id of this SubInterface. # noqa: E501

VLAN ID of the virtual LAN used by this sub interface. VLAN IDs can range from 0 to 4094. # noqa: E501

Returns

The vlan_id of this SubInterface. # noqa: E501

Return type

int

vmware.vmc.console.models.sub_interfaces module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.sub_interfaces.SubInterfaces(sub_interfaces=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SubInterfaces - a model defined in OpenAPI

attribute_map = {'sub_interfaces': 'subInterfaces'}
openapi_types = {'sub_interfaces': 'list[SubInterface]'}
property sub_interfaces

Gets the sub_interfaces of this SubInterfaces. # noqa: E501

List of sub interfaces. # noqa: E501

Returns

The sub_interfaces of this SubInterfaces. # noqa: E501

Return type

list[SubInterface]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.subnet module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.subnet.Subnet(subnet_id=None, name=None, route_tables=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Subnet - a model defined in OpenAPI

attribute_map = {'name': 'name', 'route_tables': 'route_tables', 'subnet_id': 'subnet_id'}
property name

Gets the name of this Subnet. # noqa: E501

subnet name # noqa: E501

Returns

The name of this Subnet. # noqa: E501

Return type

str

openapi_types = {'name': 'str', 'route_tables': 'list[SubnetRouteTableInfo]', 'subnet_id': 'str'}
property route_tables

Gets the route_tables of this Subnet. # noqa: E501

Returns

The route_tables of this Subnet. # noqa: E501

Return type

list[SubnetRouteTableInfo]

property subnet_id

Gets the subnet_id of this Subnet. # noqa: E501

subnet id # noqa: E501

Returns

The subnet_id of this Subnet. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.subnet_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.subnet_info.SubnetInfo(local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SubnetInfo - a model defined in OpenAPI

attribute_map = {}
openapi_types = {}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.subnet_info_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.subnet_info_all_of.SubnetInfoAllOf(compatible=None, connected_account_id=None, region_name=None, availability_zone=None, subnet_id=None, availability_zone_id=None, subnet_cidr_block=None, note=None, vpc_id=None, vpc_cidr_block=None, name=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SubnetInfoAllOf - a model defined in OpenAPI

attribute_map = {'availability_zone': 'availability_zone', 'availability_zone_id': 'availability_zone_id', 'compatible': 'compatible', 'connected_account_id': 'connected_account_id', 'name': 'name', 'note': 'note', 'region_name': 'region_name', 'subnet_cidr_block': 'subnet_cidr_block', 'subnet_id': 'subnet_id', 'vpc_cidr_block': 'vpc_cidr_block', 'vpc_id': 'vpc_id'}
property availability_zone

Gets the availability_zone of this SubnetInfoAllOf. # noqa: E501

The availability zone (customer-centric) this subnet is in. # noqa: E501

Returns

The availability_zone of this SubnetInfoAllOf. # noqa: E501

Return type

str

property availability_zone_id

Gets the availability_zone_id of this SubnetInfoAllOf. # noqa: E501

The availability zone id (customer-centric) this subnet is in. # noqa: E501

Returns

The availability_zone_id of this SubnetInfoAllOf. # noqa: E501

Return type

str

property compatible

Gets the compatible of this SubnetInfoAllOf. # noqa: E501

Is this customer subnet compatible with the SDDC? # noqa: E501

Returns

The compatible of this SubnetInfoAllOf. # noqa: E501

Return type

bool

property connected_account_id

Gets the connected_account_id of this SubnetInfoAllOf. # noqa: E501

The ID of the connected account this subnet is from. # noqa: E501

Returns

The connected_account_id of this SubnetInfoAllOf. # noqa: E501

Return type

str

property name

Gets the name of this SubnetInfoAllOf. # noqa: E501

The name of the subnet. This is either the tagged name or the default AWS id it was given. # noqa: E501

Returns

The name of this SubnetInfoAllOf. # noqa: E501

Return type

str

property note

Gets the note of this SubnetInfoAllOf. # noqa: E501

Why a subnet is marked as not compatible. May be blank if compatible. # noqa: E501

Returns

The note of this SubnetInfoAllOf. # noqa: E501

Return type

str

openapi_types = {'availability_zone': 'str', 'availability_zone_id': 'str', 'compatible': 'bool', 'connected_account_id': 'str', 'name': 'str', 'note': 'str', 'region_name': 'str', 'subnet_cidr_block': 'str', 'subnet_id': 'str', 'vpc_cidr_block': 'str', 'vpc_id': 'str'}
property region_name

Gets the region_name of this SubnetInfoAllOf. # noqa: E501

The region this subnet is from. # noqa: E501

Returns

The region_name of this SubnetInfoAllOf. # noqa: E501

Return type

str

property subnet_cidr_block

Gets the subnet_cidr_block of this SubnetInfoAllOf. # noqa: E501

The CIDR block of the subnet. # noqa: E501

Returns

The subnet_cidr_block of this SubnetInfoAllOf. # noqa: E501

Return type

str

property subnet_id

Gets the subnet_id of this SubnetInfoAllOf. # noqa: E501

The ID of the subnet. # noqa: E501

Returns

The subnet_id of this SubnetInfoAllOf. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpc_cidr_block

Gets the vpc_cidr_block of this SubnetInfoAllOf. # noqa: E501

The CIDR block of the VPC containing this subnet. # noqa: E501

Returns

The vpc_cidr_block of this SubnetInfoAllOf. # noqa: E501

Return type

str

property vpc_id

Gets the vpc_id of this SubnetInfoAllOf. # noqa: E501

The ID of the VPC this subnet resides in. # noqa: E501

Returns

The vpc_id of this SubnetInfoAllOf. # noqa: E501

Return type

str

vmware.vmc.console.models.subnet_route_table_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.subnet_route_table_info.SubnetRouteTableInfo(subnet_id=None, association_id=None, routetable_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SubnetRouteTableInfo - a model defined in OpenAPI

property association_id

Gets the association_id of this SubnetRouteTableInfo. # noqa: E501

subnet - route table association id # noqa: E501

Returns

The association_id of this SubnetRouteTableInfo. # noqa: E501

Return type

str

attribute_map = {'association_id': 'association_id', 'routetable_id': 'routetable_id', 'subnet_id': 'subnet_id'}
openapi_types = {'association_id': 'str', 'routetable_id': 'str', 'subnet_id': 'str'}
property routetable_id

Gets the routetable_id of this SubnetRouteTableInfo. # noqa: E501

route table id # noqa: E501

Returns

The routetable_id of this SubnetRouteTableInfo. # noqa: E501

Return type

str

property subnet_id

Gets the subnet_id of this SubnetRouteTableInfo. # noqa: E501

subnet id # noqa: E501

Returns

The subnet_id of this SubnetRouteTableInfo. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.subnets module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.subnets.Subnets(subnets=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Subnets - a model defined in OpenAPI

attribute_map = {'subnets': 'subnets'}
openapi_types = {'subnets': 'list[str]'}
property subnets

Gets the subnets of this Subnets. # noqa: E501

List of subnets for which IPsec VPN is configured. Subnets should be network address specified in CIDR format and can accept ‘0.0.0.0/0’ (any) # noqa: E501

Returns

The subnets of this Subnets. # noqa: E501

Return type

list[str]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.subscription_details module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.subscription_details.SubscriptionDetails(status=None, anniversary_billing_date=None, end_date=None, billing_frequency=None, auto_renewed_allowed=None, commitment_term=None, csp_subscription_id=None, billing_subscription_id=None, offer_version=None, offer_type=None, description=None, product_id=None, region=None, product_name=None, offer_name=None, commitment_term_uom=None, start_date=None, quantity=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SubscriptionDetails - a model defined in OpenAPI

property anniversary_billing_date

Gets the anniversary_billing_date of this SubscriptionDetails. # noqa: E501

Returns

The anniversary_billing_date of this SubscriptionDetails. # noqa: E501

Return type

str

attribute_map = {'anniversary_billing_date': 'anniversary_billing_date', 'auto_renewed_allowed': 'auto_renewed_allowed', 'billing_frequency': 'billing_frequency', 'billing_subscription_id': 'billing_subscription_id', 'commitment_term': 'commitment_term', 'commitment_term_uom': 'commitment_term_uom', 'csp_subscription_id': 'csp_subscription_id', 'description': 'description', 'end_date': 'end_date', 'offer_name': 'offer_name', 'offer_type': 'offer_type', 'offer_version': 'offer_version', 'product_id': 'product_id', 'product_name': 'product_name', 'quantity': 'quantity', 'region': 'region', 'start_date': 'start_date', 'status': 'status'}
property auto_renewed_allowed

Gets the auto_renewed_allowed of this SubscriptionDetails. # noqa: E501

Returns

The auto_renewed_allowed of this SubscriptionDetails. # noqa: E501

Return type

str

property billing_frequency

Gets the billing_frequency of this SubscriptionDetails. # noqa: E501

The frequency at which the customer is billed. Currently supported values are “Upfront” and “Monthly” # noqa: E501

Returns

The billing_frequency of this SubscriptionDetails. # noqa: E501

Return type

str

property billing_subscription_id

Gets the billing_subscription_id of this SubscriptionDetails. # noqa: E501

Returns

The billing_subscription_id of this SubscriptionDetails. # noqa: E501

Return type

str

property commitment_term

Gets the commitment_term of this SubscriptionDetails. # noqa: E501

Returns

The commitment_term of this SubscriptionDetails. # noqa: E501

Return type

str

property commitment_term_uom

Gets the commitment_term_uom of this SubscriptionDetails. # noqa: E501

unit of measurment for commitment term # noqa: E501

Returns

The commitment_term_uom of this SubscriptionDetails. # noqa: E501

Return type

str

property csp_subscription_id

Gets the csp_subscription_id of this SubscriptionDetails. # noqa: E501

Returns

The csp_subscription_id of this SubscriptionDetails. # noqa: E501

Return type

str

property description

Gets the description of this SubscriptionDetails. # noqa: E501

Returns

The description of this SubscriptionDetails. # noqa: E501

Return type

str

property end_date

Gets the end_date of this SubscriptionDetails. # noqa: E501

Returns

The end_date of this SubscriptionDetails. # noqa: E501

Return type

str

property offer_name

Gets the offer_name of this SubscriptionDetails. # noqa: E501

Returns

The offer_name of this SubscriptionDetails. # noqa: E501

Return type

str

property offer_type

Gets the offer_type of this SubscriptionDetails. # noqa: E501

Returns

The offer_type of this SubscriptionDetails. # noqa: E501

Return type

OfferType

property offer_version

Gets the offer_version of this SubscriptionDetails. # noqa: E501

Returns

The offer_version of this SubscriptionDetails. # noqa: E501

Return type

str

openapi_types = {'anniversary_billing_date': 'str', 'auto_renewed_allowed': 'str', 'billing_frequency': 'str', 'billing_subscription_id': 'str', 'commitment_term': 'str', 'commitment_term_uom': 'str', 'csp_subscription_id': 'str', 'description': 'str', 'end_date': 'str', 'offer_name': 'str', 'offer_type': 'OfferType', 'offer_version': 'str', 'product_id': 'str', 'product_name': 'str', 'quantity': 'str', 'region': 'str', 'start_date': 'str', 'status': 'str'}
property product_id

Gets the product_id of this SubscriptionDetails. # noqa: E501

Returns

The product_id of this SubscriptionDetails. # noqa: E501

Return type

str

property product_name

Gets the product_name of this SubscriptionDetails. # noqa: E501

Returns

The product_name of this SubscriptionDetails. # noqa: E501

Return type

str

property quantity

Gets the quantity of this SubscriptionDetails. # noqa: E501

Returns

The quantity of this SubscriptionDetails. # noqa: E501

Return type

str

property region

Gets the region of this SubscriptionDetails. # noqa: E501

Returns

The region of this SubscriptionDetails. # noqa: E501

Return type

str

property start_date

Gets the start_date of this SubscriptionDetails. # noqa: E501

Returns

The start_date of this SubscriptionDetails. # noqa: E501

Return type

str

property status

Gets the status of this SubscriptionDetails. # noqa: E501

Returns

The status of this SubscriptionDetails. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.subscription_products module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.subscription_products.SubscriptionProducts(product=None, types=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SubscriptionProducts - a model defined in OpenAPI

attribute_map = {'product': 'product', 'types': 'types'}
openapi_types = {'product': 'str', 'types': 'list[str]'}
property product

Gets the product of this SubscriptionProducts. # noqa: E501

The name of the product # noqa: E501

Returns

The product of this SubscriptionProducts. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property types

Gets the types of this SubscriptionProducts. # noqa: E501

A list of different types/version for the product. # noqa: E501

Returns

The types of this SubscriptionProducts. # noqa: E501

Return type

list[str]

vmware.vmc.console.models.subscription_request module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.subscription_request.SubscriptionRequest(product=None, product_type=None, product_id=None, billing_frequency=None, region=None, commitment_term=None, offer_context_id=None, offer_version=None, offer_name=None, quantity=None, type=None, price=None, product_charge_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SubscriptionRequest - a model defined in OpenAPI

attribute_map = {'billing_frequency': 'billing_frequency', 'commitment_term': 'commitment_term', 'offer_context_id': 'offer_context_id', 'offer_name': 'offer_name', 'offer_version': 'offer_version', 'price': 'price', 'product': 'product', 'product_charge_id': 'product_charge_id', 'product_id': 'product_id', 'product_type': 'product_type', 'quantity': 'quantity', 'region': 'region', 'type': 'type'}
property billing_frequency

Gets the billing_frequency of this SubscriptionRequest. # noqa: E501

Frequency of the billing. # noqa: E501

Returns

The billing_frequency of this SubscriptionRequest. # noqa: E501

Return type

str

property commitment_term

Gets the commitment_term of this SubscriptionRequest. # noqa: E501

Returns

The commitment_term of this SubscriptionRequest. # noqa: E501

Return type

str

property offer_context_id

Gets the offer_context_id of this SubscriptionRequest. # noqa: E501

Returns

The offer_context_id of this SubscriptionRequest. # noqa: E501

Return type

str

property offer_name

Gets the offer_name of this SubscriptionRequest. # noqa: E501

Returns

The offer_name of this SubscriptionRequest. # noqa: E501

Return type

str

property offer_version

Gets the offer_version of this SubscriptionRequest. # noqa: E501

Returns

The offer_version of this SubscriptionRequest. # noqa: E501

Return type

str

openapi_types = {'billing_frequency': 'str', 'commitment_term': 'str', 'offer_context_id': 'str', 'offer_name': 'str', 'offer_version': 'str', 'price': 'int', 'product': 'str', 'product_charge_id': 'str', 'product_id': 'str', 'product_type': 'str', 'quantity': 'int', 'region': 'str', 'type': 'str'}
property price

Gets the price of this SubscriptionRequest. # noqa: E501

Returns

The price of this SubscriptionRequest. # noqa: E501

Return type

int

property product

Gets the product of this SubscriptionRequest. # noqa: E501

The product for which subscription needs to be created. Refer /vmc/api/orgs/{orgId}/products. # noqa: E501

Returns

The product of this SubscriptionRequest. # noqa: E501

Return type

str

property product_charge_id

Gets the product_charge_id of this SubscriptionRequest. # noqa: E501

Returns

The product_charge_id of this SubscriptionRequest. # noqa: E501

Return type

str

property product_id

Gets the product_id of this SubscriptionRequest. # noqa: E501

Returns

The product_id of this SubscriptionRequest. # noqa: E501

Return type

str

property product_type

Gets the product_type of this SubscriptionRequest. # noqa: E501

Old identifier for product. Deprecarted. See product and type # noqa: E501

Returns

The product_type of this SubscriptionRequest. # noqa: E501

Return type

str

property quantity

Gets the quantity of this SubscriptionRequest. # noqa: E501

Returns

The quantity of this SubscriptionRequest. # noqa: E501

Return type

int

property region

Gets the region of this SubscriptionRequest. # noqa: E501

Returns

The region of this SubscriptionRequest. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this SubscriptionRequest. # noqa: E501

The type of the product for which the subscription needs to be created. # noqa: E501

Returns

The type of this SubscriptionRequest. # noqa: E501

Return type

str

vmware.vmc.console.models.support_window module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.support_window.SupportWindow(start_day=None, seats=None, sddcs=None, duration_hours=None, start_hour=None, support_window_id=None, metadata=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SupportWindow - a model defined in OpenAPI

attribute_map = {'duration_hours': 'duration_hours', 'metadata': 'metadata', 'sddcs': 'sddcs', 'seats': 'seats', 'start_day': 'start_day', 'start_hour': 'start_hour', 'support_window_id': 'support_window_id'}
property duration_hours

Gets the duration_hours of this SupportWindow. # noqa: E501

Returns

The duration_hours of this SupportWindow. # noqa: E501

Return type

int

property metadata

Gets the metadata of this SupportWindow. # noqa: E501

Returns

The metadata of this SupportWindow. # noqa: E501

Return type

object

openapi_types = {'duration_hours': 'int', 'metadata': 'object', 'sddcs': 'list[str]', 'seats': 'int', 'start_day': 'str', 'start_hour': 'int', 'support_window_id': 'str'}
property sddcs

Gets the sddcs of this SupportWindow. # noqa: E501

SDDCs in this window # noqa: E501

Returns

The sddcs of this SupportWindow. # noqa: E501

Return type

list[str]

property seats

Gets the seats of this SupportWindow. # noqa: E501

Returns

The seats of this SupportWindow. # noqa: E501

Return type

int

property start_day

Gets the start_day of this SupportWindow. # noqa: E501

Returns

The start_day of this SupportWindow. # noqa: E501

Return type

str

property start_hour

Gets the start_hour of this SupportWindow. # noqa: E501

Returns

The start_hour of this SupportWindow. # noqa: E501

Return type

int

property support_window_id

Gets the support_window_id of this SupportWindow. # noqa: E501

Returns

The support_window_id of this SupportWindow. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.support_window_id module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.support_window_id.SupportWindowId(window_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

SupportWindowId - a model defined in OpenAPI

attribute_map = {'window_id': 'window_id'}
openapi_types = {'window_id': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property window_id

Gets the window_id of this SupportWindowId. # noqa: E501

Support Window ID # noqa: E501

Returns

The window_id of this SupportWindowId. # noqa: E501

Return type

str

vmware.vmc.console.models.task module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.task.Task(updated=None, user_id=None, updated_by_user_id=None, created=None, version=None, updated_by_user_name=None, user_name=None, id=None, status=None, localized_error_message=None, resource_id=None, parent_task_id=None, task_version=None, correlation_id=None, start_resource_entity_version=None, sub_status=None, task_type=None, start_time=None, task_progress_phases=None, error_message=None, org_id=None, end_resource_entity_version=None, service_errors=None, org_type=None, estimated_remaining_minutes=None, params=None, progress_percent=None, phase_in_progress=None, resource_type=None, end_time=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Task - a model defined in OpenAPI

attribute_map = {'correlation_id': 'correlation_id', 'created': 'created', 'end_resource_entity_version': 'end_resource_entity_version', 'end_time': 'end_time', 'error_message': 'error_message', 'estimated_remaining_minutes': 'estimated_remaining_minutes', 'id': 'id', 'localized_error_message': 'localized_error_message', 'org_id': 'org_id', 'org_type': 'org_type', 'params': 'params', 'parent_task_id': 'parent_task_id', 'phase_in_progress': 'phase_in_progress', 'progress_percent': 'progress_percent', 'resource_id': 'resource_id', 'resource_type': 'resource_type', 'service_errors': 'service_errors', 'start_resource_entity_version': 'start_resource_entity_version', 'start_time': 'start_time', 'status': 'status', 'sub_status': 'sub_status', 'task_progress_phases': 'task_progress_phases', 'task_type': 'task_type', 'task_version': 'task_version', 'updated': 'updated', 'updated_by_user_id': 'updated_by_user_id', 'updated_by_user_name': 'updated_by_user_name', 'user_id': 'user_id', 'user_name': 'user_name', 'version': 'version'}
property correlation_id

Gets the correlation_id of this Task. # noqa: E501

(Optional) Client provided uniqifier to make task creation idempotent. Be aware not all tasks support this. For tasks that do - supplying the same correlation Id, for the same task type, within a predefined window will ensure the operation happens at most once. # noqa: E501

Returns

The correlation_id of this Task. # noqa: E501

Return type

str

property created

Gets the created of this Task. # noqa: E501

Returns

The created of this Task. # noqa: E501

Return type

datetime

property end_resource_entity_version

Gets the end_resource_entity_version of this Task. # noqa: E501

Entity version of the resource at the end of the task. This is only set for some task types. # noqa: E501

Returns

The end_resource_entity_version of this Task. # noqa: E501

Return type

int

property end_time

Gets the end_time of this Task. # noqa: E501

Returns

The end_time of this Task. # noqa: E501

Return type

datetime

property error_message

Gets the error_message of this Task. # noqa: E501

Returns

The error_message of this Task. # noqa: E501

Return type

str

property estimated_remaining_minutes

Gets the estimated_remaining_minutes of this Task. # noqa: E501

Estimated remaining time in minute of the task execution, < 0 means no estimation for the task. # noqa: E501

Returns

The estimated_remaining_minutes of this Task. # noqa: E501

Return type

int

property id

Gets the id of this Task. # noqa: E501

Unique ID for this entity # noqa: E501

Returns

The id of this Task. # noqa: E501

Return type

str

property localized_error_message

Gets the localized_error_message of this Task. # noqa: E501

Returns

The localized_error_message of this Task. # noqa: E501

Return type

str

openapi_types = {'correlation_id': 'str', 'created': 'datetime', 'end_resource_entity_version': 'int', 'end_time': 'datetime', 'error_message': 'str', 'estimated_remaining_minutes': 'int', 'id': 'str', 'localized_error_message': 'str', 'org_id': 'str', 'org_type': 'str', 'params': 'object', 'parent_task_id': 'str', 'phase_in_progress': 'str', 'progress_percent': 'int', 'resource_id': 'str', 'resource_type': 'str', 'service_errors': 'list[ServiceError]', 'start_resource_entity_version': 'int', 'start_time': 'datetime', 'status': 'str', 'sub_status': 'str', 'task_progress_phases': 'list[TaskProgressPhase]', 'task_type': 'str', 'task_version': 'str', 'updated': 'datetime', 'updated_by_user_id': 'str', 'updated_by_user_name': 'str', 'user_id': 'str', 'user_name': 'str', 'version': 'int'}
property org_id

Gets the org_id of this Task. # noqa: E501

Returns

The org_id of this Task. # noqa: E501

Return type

str

property org_type

Gets the org_type of this Task. # noqa: E501

Returns

The org_type of this Task. # noqa: E501

Return type

str

property params

Gets the params of this Task. # noqa: E501

Returns

The params of this Task. # noqa: E501

Return type

object

property parent_task_id

Gets the parent_task_id of this Task. # noqa: E501

If this task was created by another task - this provides the linkage. Mostly for debugging. # noqa: E501

Returns

The parent_task_id of this Task. # noqa: E501

Return type

str

property phase_in_progress

Gets the phase_in_progress of this Task. # noqa: E501

The current in progress phase ID in the task execution, if none in progress, empty string returned. # noqa: E501

Returns

The phase_in_progress of this Task. # noqa: E501

Return type

str

property progress_percent

Gets the progress_percent of this Task. # noqa: E501

Estimated progress percentage the task executed # noqa: E501

Returns

The progress_percent of this Task. # noqa: E501

Return type

int

property resource_id

Gets the resource_id of this Task. # noqa: E501

UUID of the resource the task is acting upon # noqa: E501

Returns

The resource_id of this Task. # noqa: E501

Return type

str

property resource_type

Gets the resource_type of this Task. # noqa: E501

Type of resource being acted upon # noqa: E501

Returns

The resource_type of this Task. # noqa: E501

Return type

str

property service_errors

Gets the service_errors of this Task. # noqa: E501

Service errors returned from SDDC services. # noqa: E501

Returns

The service_errors of this Task. # noqa: E501

Return type

list[ServiceError]

property start_resource_entity_version

Gets the start_resource_entity_version of this Task. # noqa: E501

Entity version of the resource at the start of the task. This is only set for some task types. # noqa: E501

Returns

The start_resource_entity_version of this Task. # noqa: E501

Return type

int

property start_time

Gets the start_time of this Task. # noqa: E501

Returns

The start_time of this Task. # noqa: E501

Return type

datetime

property status

Gets the status of this Task. # noqa: E501

Returns

The status of this Task. # noqa: E501

Return type

str

property sub_status

Gets the sub_status of this Task. # noqa: E501

Returns

The sub_status of this Task. # noqa: E501

Return type

str

property task_progress_phases

Gets the task_progress_phases of this Task. # noqa: E501

Task progress phases involved in current task execution # noqa: E501

Returns

The task_progress_phases of this Task. # noqa: E501

Return type

list[TaskProgressPhase]

property task_type

Gets the task_type of this Task. # noqa: E501

Returns

The task_type of this Task. # noqa: E501

Return type

str

property task_version

Gets the task_version of this Task. # noqa: E501

Returns

The task_version of this Task. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property updated

Gets the updated of this Task. # noqa: E501

Returns

The updated of this Task. # noqa: E501

Return type

datetime

property updated_by_user_id

Gets the updated_by_user_id of this Task. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The updated_by_user_id of this Task. # noqa: E501

Return type

str

property updated_by_user_name

Gets the updated_by_user_name of this Task. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The updated_by_user_name of this Task. # noqa: E501

Return type

str

property user_id

Gets the user_id of this Task. # noqa: E501

User id that last updated this record # noqa: E501

Returns

The user_id of this Task. # noqa: E501

Return type

str

property user_name

Gets the user_name of this Task. # noqa: E501

User name that last updated this record # noqa: E501

Returns

The user_name of this Task. # noqa: E501

Return type

str

property version

Gets the version of this Task. # noqa: E501

Version of this entity # noqa: E501

Returns

The version of this Task. # noqa: E501

Return type

int

vmware.vmc.console.models.task_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.task_all_of.TaskAllOf(status=None, localized_error_message=None, resource_id=None, parent_task_id=None, task_version=None, correlation_id=None, start_resource_entity_version=None, sub_status=None, task_type=None, start_time=None, task_progress_phases=None, error_message=None, org_id=None, end_resource_entity_version=None, service_errors=None, org_type=None, estimated_remaining_minutes=None, params=None, progress_percent=None, phase_in_progress=None, resource_type=None, end_time=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

TaskAllOf - a model defined in OpenAPI

attribute_map = {'correlation_id': 'correlation_id', 'end_resource_entity_version': 'end_resource_entity_version', 'end_time': 'end_time', 'error_message': 'error_message', 'estimated_remaining_minutes': 'estimated_remaining_minutes', 'localized_error_message': 'localized_error_message', 'org_id': 'org_id', 'org_type': 'org_type', 'params': 'params', 'parent_task_id': 'parent_task_id', 'phase_in_progress': 'phase_in_progress', 'progress_percent': 'progress_percent', 'resource_id': 'resource_id', 'resource_type': 'resource_type', 'service_errors': 'service_errors', 'start_resource_entity_version': 'start_resource_entity_version', 'start_time': 'start_time', 'status': 'status', 'sub_status': 'sub_status', 'task_progress_phases': 'task_progress_phases', 'task_type': 'task_type', 'task_version': 'task_version'}
property correlation_id

Gets the correlation_id of this TaskAllOf. # noqa: E501

(Optional) Client provided uniqifier to make task creation idempotent. Be aware not all tasks support this. For tasks that do - supplying the same correlation Id, for the same task type, within a predefined window will ensure the operation happens at most once. # noqa: E501

Returns

The correlation_id of this TaskAllOf. # noqa: E501

Return type

str

property end_resource_entity_version

Gets the end_resource_entity_version of this TaskAllOf. # noqa: E501

Entity version of the resource at the end of the task. This is only set for some task types. # noqa: E501

Returns

The end_resource_entity_version of this TaskAllOf. # noqa: E501

Return type

int

property end_time

Gets the end_time of this TaskAllOf. # noqa: E501

Returns

The end_time of this TaskAllOf. # noqa: E501

Return type

datetime

property error_message

Gets the error_message of this TaskAllOf. # noqa: E501

Returns

The error_message of this TaskAllOf. # noqa: E501

Return type

str

property estimated_remaining_minutes

Gets the estimated_remaining_minutes of this TaskAllOf. # noqa: E501

Estimated remaining time in minute of the task execution, < 0 means no estimation for the task. # noqa: E501

Returns

The estimated_remaining_minutes of this TaskAllOf. # noqa: E501

Return type

int

property localized_error_message

Gets the localized_error_message of this TaskAllOf. # noqa: E501

Returns

The localized_error_message of this TaskAllOf. # noqa: E501

Return type

str

openapi_types = {'correlation_id': 'str', 'end_resource_entity_version': 'int', 'end_time': 'datetime', 'error_message': 'str', 'estimated_remaining_minutes': 'int', 'localized_error_message': 'str', 'org_id': 'str', 'org_type': 'str', 'params': 'object', 'parent_task_id': 'str', 'phase_in_progress': 'str', 'progress_percent': 'int', 'resource_id': 'str', 'resource_type': 'str', 'service_errors': 'list[ServiceError]', 'start_resource_entity_version': 'int', 'start_time': 'datetime', 'status': 'str', 'sub_status': 'str', 'task_progress_phases': 'list[TaskProgressPhase]', 'task_type': 'str', 'task_version': 'str'}
property org_id

Gets the org_id of this TaskAllOf. # noqa: E501

Returns

The org_id of this TaskAllOf. # noqa: E501

Return type

str

property org_type

Gets the org_type of this TaskAllOf. # noqa: E501

Returns

The org_type of this TaskAllOf. # noqa: E501

Return type

str

property params

Gets the params of this TaskAllOf. # noqa: E501

Returns

The params of this TaskAllOf. # noqa: E501

Return type

object

property parent_task_id

Gets the parent_task_id of this TaskAllOf. # noqa: E501

If this task was created by another task - this provides the linkage. Mostly for debugging. # noqa: E501

Returns

The parent_task_id of this TaskAllOf. # noqa: E501

Return type

str

property phase_in_progress

Gets the phase_in_progress of this TaskAllOf. # noqa: E501

The current in progress phase ID in the task execution, if none in progress, empty string returned. # noqa: E501

Returns

The phase_in_progress of this TaskAllOf. # noqa: E501

Return type

str

property progress_percent

Gets the progress_percent of this TaskAllOf. # noqa: E501

Estimated progress percentage the task executed # noqa: E501

Returns

The progress_percent of this TaskAllOf. # noqa: E501

Return type

int

property resource_id

Gets the resource_id of this TaskAllOf. # noqa: E501

UUID of the resource the task is acting upon # noqa: E501

Returns

The resource_id of this TaskAllOf. # noqa: E501

Return type

str

property resource_type

Gets the resource_type of this TaskAllOf. # noqa: E501

Type of resource being acted upon # noqa: E501

Returns

The resource_type of this TaskAllOf. # noqa: E501

Return type

str

property service_errors

Gets the service_errors of this TaskAllOf. # noqa: E501

Service errors returned from SDDC services. # noqa: E501

Returns

The service_errors of this TaskAllOf. # noqa: E501

Return type

list[ServiceError]

property start_resource_entity_version

Gets the start_resource_entity_version of this TaskAllOf. # noqa: E501

Entity version of the resource at the start of the task. This is only set for some task types. # noqa: E501

Returns

The start_resource_entity_version of this TaskAllOf. # noqa: E501

Return type

int

property start_time

Gets the start_time of this TaskAllOf. # noqa: E501

Returns

The start_time of this TaskAllOf. # noqa: E501

Return type

datetime

property status

Gets the status of this TaskAllOf. # noqa: E501

Returns

The status of this TaskAllOf. # noqa: E501

Return type

str

property sub_status

Gets the sub_status of this TaskAllOf. # noqa: E501

Returns

The sub_status of this TaskAllOf. # noqa: E501

Return type

str

property task_progress_phases

Gets the task_progress_phases of this TaskAllOf. # noqa: E501

Task progress phases involved in current task execution # noqa: E501

Returns

The task_progress_phases of this TaskAllOf. # noqa: E501

Return type

list[TaskProgressPhase]

property task_type

Gets the task_type of this TaskAllOf. # noqa: E501

Returns

The task_type of this TaskAllOf. # noqa: E501

Return type

str

property task_version

Gets the task_version of this TaskAllOf. # noqa: E501

Returns

The task_version of this TaskAllOf. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.task_progress_phase module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.task_progress_phase.TaskProgressPhase(id=None, name=None, progress_percent=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

TaskProgressPhase - a model defined in OpenAPI

attribute_map = {'id': 'id', 'name': 'name', 'progress_percent': 'progress_percent'}
property id

Gets the id of this TaskProgressPhase. # noqa: E501

The identifier of the task progress phase # noqa: E501

Returns

The id of this TaskProgressPhase. # noqa: E501

Return type

str

property name

Gets the name of this TaskProgressPhase. # noqa: E501

The display name of the task progress phase # noqa: E501

Returns

The name of this TaskProgressPhase. # noqa: E501

Return type

str

openapi_types = {'id': 'str', 'name': 'str', 'progress_percent': 'int'}
property progress_percent

Gets the progress_percent of this TaskProgressPhase. # noqa: E501

The percentage of the phase that has completed # noqa: E501

Returns

The progress_percent of this TaskProgressPhase. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.term_billing_options module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.term_billing_options.TermBillingOptions(unit_price=None, billing_frequency=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

TermBillingOptions - a model defined in OpenAPI

attribute_map = {'billing_frequency': 'billing_frequency', 'unit_price': 'unit_price'}
property billing_frequency

Gets the billing_frequency of this TermBillingOptions. # noqa: E501

Returns

The billing_frequency of this TermBillingOptions. # noqa: E501

Return type

str

openapi_types = {'billing_frequency': 'str', 'unit_price': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property unit_price

Gets the unit_price of this TermBillingOptions. # noqa: E501

Returns

The unit_price of this TermBillingOptions. # noqa: E501

Return type

str

vmware.vmc.console.models.term_offer_instance module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.term_offer_instance.TermOfferInstance(description=None, product=None, product_type=None, name=None, currency=None, region=None, commitment_term=None, unit_price=None, billing_options=None, version=None, offer_context_id=None, product_charge_id=None, type=None, product_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

TermOfferInstance - a model defined in OpenAPI

attribute_map = {'billing_options': 'billing_options', 'commitment_term': 'commitment_term', 'currency': 'currency', 'description': 'description', 'name': 'name', 'offer_context_id': 'offer_context_id', 'product': 'product', 'product_charge_id': 'product_charge_id', 'product_id': 'product_id', 'product_type': 'product_type', 'region': 'region', 'type': 'type', 'unit_price': 'unit_price', 'version': 'version'}
property billing_options

Gets the billing_options of this TermOfferInstance. # noqa: E501

Returns

The billing_options of this TermOfferInstance. # noqa: E501

Return type

list[TermBillingOptions]

property commitment_term

Gets the commitment_term of this TermOfferInstance. # noqa: E501

Returns

The commitment_term of this TermOfferInstance. # noqa: E501

Return type

int

property currency

Gets the currency of this TermOfferInstance. # noqa: E501

Returns

The currency of this TermOfferInstance. # noqa: E501

Return type

str

property description

Gets the description of this TermOfferInstance. # noqa: E501

Returns

The description of this TermOfferInstance. # noqa: E501

Return type

str

property name

Gets the name of this TermOfferInstance. # noqa: E501

Returns

The name of this TermOfferInstance. # noqa: E501

Return type

str

property offer_context_id

Gets the offer_context_id of this TermOfferInstance. # noqa: E501

Returns

The offer_context_id of this TermOfferInstance. # noqa: E501

Return type

str

openapi_types = {'billing_options': 'list[TermBillingOptions]', 'commitment_term': 'int', 'currency': 'str', 'description': 'str', 'name': 'str', 'offer_context_id': 'str', 'product': 'str', 'product_charge_id': 'str', 'product_id': 'str', 'product_type': 'str', 'region': 'str', 'type': 'str', 'unit_price': 'str', 'version': 'str'}
property product

Gets the product of this TermOfferInstance. # noqa: E501

Returns

The product of this TermOfferInstance. # noqa: E501

Return type

str

property product_charge_id

Gets the product_charge_id of this TermOfferInstance. # noqa: E501

Returns

The product_charge_id of this TermOfferInstance. # noqa: E501

Return type

str

property product_id

Gets the product_id of this TermOfferInstance. # noqa: E501

Returns

The product_id of this TermOfferInstance. # noqa: E501

Return type

str

property product_type

Gets the product_type of this TermOfferInstance. # noqa: E501

Deprecated. Please use product and type fields instead. # noqa: E501

Returns

The product_type of this TermOfferInstance. # noqa: E501

Return type

str

property region

Gets the region of this TermOfferInstance. # noqa: E501

Returns

The region of this TermOfferInstance. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this TermOfferInstance. # noqa: E501

Returns

The type of this TermOfferInstance. # noqa: E501

Return type

str

property unit_price

Gets the unit_price of this TermOfferInstance. # noqa: E501

(deprecated. unit_price is moved into TermBillingOptions. For backward compatibility, this field reflect “Prepaid” price at the offer level.) # noqa: E501

Returns

The unit_price of this TermOfferInstance. # noqa: E501

Return type

str

property version

Gets the version of this TermOfferInstance. # noqa: E501

Returns

The version of this TermOfferInstance. # noqa: E501

Return type

str

vmware.vmc.console.models.traffic_shaping_policy module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.traffic_shaping_policy.TrafficShapingPolicy(burst_size=None, average_bandwidth=None, peak_bandwidth=None, enabled=None, inherited=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

TrafficShapingPolicy - a model defined in OpenAPI

attribute_map = {'average_bandwidth': 'averageBandwidth', 'burst_size': 'burstSize', 'enabled': 'enabled', 'inherited': 'inherited', 'peak_bandwidth': 'peakBandwidth'}
property average_bandwidth

Gets the average_bandwidth of this TrafficShapingPolicy. # noqa: E501

Returns

The average_bandwidth of this TrafficShapingPolicy. # noqa: E501

Return type

int

property burst_size

Gets the burst_size of this TrafficShapingPolicy. # noqa: E501

Returns

The burst_size of this TrafficShapingPolicy. # noqa: E501

Return type

int

property enabled

Gets the enabled of this TrafficShapingPolicy. # noqa: E501

Returns

The enabled of this TrafficShapingPolicy. # noqa: E501

Return type

bool

property inherited

Gets the inherited of this TrafficShapingPolicy. # noqa: E501

Returns

The inherited of this TrafficShapingPolicy. # noqa: E501

Return type

bool

openapi_types = {'average_bandwidth': 'int', 'burst_size': 'int', 'enabled': 'bool', 'inherited': 'bool', 'peak_bandwidth': 'int'}
property peak_bandwidth

Gets the peak_bandwidth of this TrafficShapingPolicy. # noqa: E501

Returns

The peak_bandwidth of this TrafficShapingPolicy. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.update_credentials module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.update_credentials.UpdateCredentials(username=None, password=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

UpdateCredentials - a model defined in OpenAPI

attribute_map = {'password': 'password', 'username': 'username'}
openapi_types = {'password': 'str', 'username': 'str'}
property password

Gets the password of this UpdateCredentials. # noqa: E501

Password associated with the credentials # noqa: E501

Returns

The password of this UpdateCredentials. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property username

Gets the username of this UpdateCredentials. # noqa: E501

Username of the credentials # noqa: E501

Returns

The username of this UpdateCredentials. # noqa: E501

Return type

str

vmware.vmc.console.models.vmc_locale module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vmc_locale.VmcLocale(locale=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VmcLocale - a model defined in OpenAPI

attribute_map = {'locale': 'locale'}
property locale

Gets the locale of this VmcLocale. # noqa: E501

The locale to be used for translating responses for the session # noqa: E501

Returns

The locale of this VmcLocale. # noqa: E501

Return type

str

openapi_types = {'locale': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.vnic module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vnic.Vnic(sub_interfaces=None, address_groups=None, is_connected=None, enable_send_redirects=None, in_shaping_policy=None, label=None, enable_proxy_arp=None, index=None, name=None, mtu=None, fence_parameters=None, mac_addresses=None, out_shaping_policy=None, portgroup_name=None, enable_bridge_mode=None, type=None, portgroup_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Vnic - a model defined in OpenAPI

property address_groups

Gets the address_groups of this Vnic. # noqa: E501

Returns

The address_groups of this Vnic. # noqa: E501

Return type

EdgeVnicAddressGroups

attribute_map = {'address_groups': 'addressGroups', 'enable_bridge_mode': 'enableBridgeMode', 'enable_proxy_arp': 'enableProxyArp', 'enable_send_redirects': 'enableSendRedirects', 'fence_parameters': 'fenceParameters', 'in_shaping_policy': 'inShapingPolicy', 'index': 'index', 'is_connected': 'isConnected', 'label': 'label', 'mac_addresses': 'macAddresses', 'mtu': 'mtu', 'name': 'name', 'out_shaping_policy': 'outShapingPolicy', 'portgroup_id': 'portgroupId', 'portgroup_name': 'portgroupName', 'sub_interfaces': 'subInterfaces', 'type': 'type'}
property enable_bridge_mode

Gets the enable_bridge_mode of this Vnic. # noqa: E501

Value is true if bridge mode is enabled. # noqa: E501

Returns

The enable_bridge_mode of this Vnic. # noqa: E501

Return type

bool

property enable_proxy_arp

Gets the enable_proxy_arp of this Vnic. # noqa: E501

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. # noqa: E501

Returns

The enable_proxy_arp of this Vnic. # noqa: E501

Return type

bool

property enable_send_redirects

Gets the enable_send_redirects of this Vnic. # noqa: E501

Value is true if send redirects is enabled. Enable ICMP redirect to convey routing information to hosts. # noqa: E501

Returns

The enable_send_redirects of this Vnic. # noqa: E501

Return type

bool

property fence_parameters

Gets the fence_parameters of this Vnic. # noqa: E501

Returns

The fence_parameters of this Vnic. # noqa: E501

Return type

list[KeyValueAttributes]

property in_shaping_policy

Gets the in_shaping_policy of this Vnic. # noqa: E501

Returns

The in_shaping_policy of this Vnic. # noqa: E501

Return type

TrafficShapingPolicy

property index

Gets the index of this Vnic. # noqa: E501

Index of the vnic. Min value is 0 and max value is 9. # noqa: E501

Returns

The index of this Vnic. # noqa: E501

Return type

int

property is_connected

Gets the is_connected of this Vnic. # noqa: E501

Value is true if the vnic is connected to a logical switch, standard portgroup or distributed portgroup. # noqa: E501

Returns

The is_connected of this Vnic. # noqa: E501

Return type

bool

property label

Gets the label of this Vnic. # noqa: E501

Interface label of format vNic_{vnicIndex} provided by NSX Manager. Read only. # noqa: E501

Returns

The label of this Vnic. # noqa: E501

Return type

str

property mac_addresses

Gets the mac_addresses of this Vnic. # noqa: E501

Distinct MAC addresses configured for the vnic. Optional. # noqa: E501

Returns

The mac_addresses of this Vnic. # noqa: E501

Return type

list[MacAddress]

property mtu

Gets the mtu of this Vnic. # noqa: E501

MTU of the interface, with default as 1500. Min is 68, Max is 9000. Optional. # noqa: E501

Returns

The mtu of this Vnic. # noqa: E501

Return type

int

property name

Gets the name of this Vnic. # noqa: E501

Name of the interface. Optional. # noqa: E501

Returns

The name of this Vnic. # noqa: E501

Return type

str

openapi_types = {'address_groups': 'EdgeVnicAddressGroups', 'enable_bridge_mode': 'bool', 'enable_proxy_arp': 'bool', 'enable_send_redirects': 'bool', 'fence_parameters': 'list[KeyValueAttributes]', 'in_shaping_policy': 'TrafficShapingPolicy', 'index': 'int', 'is_connected': 'bool', 'label': 'str', 'mac_addresses': 'list[MacAddress]', 'mtu': 'int', 'name': 'str', 'out_shaping_policy': 'TrafficShapingPolicy', 'portgroup_id': 'str', 'portgroup_name': 'str', 'sub_interfaces': 'SubInterfaces', 'type': 'str'}
property out_shaping_policy

Gets the out_shaping_policy of this Vnic. # noqa: E501

Returns

The out_shaping_policy of this Vnic. # noqa: E501

Return type

TrafficShapingPolicy

property portgroup_id

Gets the portgroup_id of this Vnic. # noqa: E501

Value are port group ID (standard portgroup or distributed portgroup) or virtual wire ID (logical switch). Logical switch cannot be used for a TRUNK vnic. Portgroup cannot be shared among vnics/LIFs. Required when isConnected is specified as true. Example ‘network-17’ (standard portgroup), ‘dvportgroup-34’ (distributed portgroup) or ‘virtualwire-2’ (logical switch). # noqa: E501

Returns

The portgroup_id of this Vnic. # noqa: E501

Return type

str

property portgroup_name

Gets the portgroup_name of this Vnic. # noqa: E501

Name of the port group or logical switch. # noqa: E501

Returns

The portgroup_name of this Vnic. # noqa: E501

Return type

str

property sub_interfaces

Gets the sub_interfaces of this Vnic. # noqa: E501

Returns

The sub_interfaces of this Vnic. # noqa: E501

Return type

SubInterfaces

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property type

Gets the type of this Vnic. # noqa: E501

Type of the vnic. Values are uplink, internal, trunk. At least one internal interface must be configured for NSX Edge HA to work. # noqa: E501

Returns

The type of this Vnic. # noqa: E501

Return type

str

vmware.vmc.console.models.vnics module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vnics.Vnics(vnics=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Vnics - a model defined in OpenAPI

attribute_map = {'vnics': 'vnics'}
openapi_types = {'vnics': 'list[Vnic]'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vnics

Gets the vnics of this Vnics. # noqa: E501

Ordered list of NSX Edge vnics. # noqa: E501

Returns

The vnics of this Vnics. # noqa: E501

Return type

list[Vnic]

vmware.vmc.console.models.vpc_info module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vpc_info.VpcInfo(vpc_cidr=None, vgw_id=None, esx_public_security_group_id=None, vif_ids=None, vm_security_group_id=None, tgw_ips=None, route_table_id=None, edge_subnet_id=None, id=None, api_association_id=None, api_subnet_id=None, private_subnet_id=None, private_association_id=None, esx_security_group_id=None, subnet_id=None, internet_gateway_id=None, security_group_id=None, association_id=None, vgw_route_table_id=None, edge_association_id=None, provider=None, peering_connection_id=None, network_type=None, available_zones=None, routetables=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VpcInfo - a model defined in OpenAPI

property api_association_id

Gets the api_association_id of this VpcInfo. # noqa: E501

Id of the association between subnet and route-table (deprecated) # noqa: E501

Returns

The api_association_id of this VpcInfo. # noqa: E501

Return type

str

property api_subnet_id

Gets the api_subnet_id of this VpcInfo. # noqa: E501

Id associated with this VPC (deprecated) # noqa: E501

Returns

The api_subnet_id of this VpcInfo. # noqa: E501

Return type

str

property association_id

Gets the association_id of this VpcInfo. # noqa: E501

(deprecated) # noqa: E501

Returns

The association_id of this VpcInfo. # noqa: E501

Return type

str

attribute_map = {'api_association_id': 'api_association_id', 'api_subnet_id': 'api_subnet_id', 'association_id': 'association_id', 'available_zones': 'available_zones', 'edge_association_id': 'edge_association_id', 'edge_subnet_id': 'edge_subnet_id', 'esx_public_security_group_id': 'esx_public_security_group_id', 'esx_security_group_id': 'esx_security_group_id', 'id': 'id', 'internet_gateway_id': 'internet_gateway_id', 'network_type': 'network_type', 'peering_connection_id': 'peering_connection_id', 'private_association_id': 'private_association_id', 'private_subnet_id': 'private_subnet_id', 'provider': 'provider', 'route_table_id': 'route_table_id', 'routetables': 'routetables', 'security_group_id': 'security_group_id', 'subnet_id': 'subnet_id', 'tgw_ips': 'tgwIps', 'vgw_id': 'vgw_id', 'vgw_route_table_id': 'vgw_route_table_id', 'vif_ids': 'vif_ids', 'vm_security_group_id': 'vm_security_group_id', 'vpc_cidr': 'vpc_cidr'}
property available_zones

Gets the available_zones of this VpcInfo. # noqa: E501

Returns

The available_zones of this VpcInfo. # noqa: E501

Return type

list[AvailableZoneInfo]

property edge_association_id

Gets the edge_association_id of this VpcInfo. # noqa: E501

Id of the association between edge subnet and route-table (deprecated) # noqa: E501

Returns

The edge_association_id of this VpcInfo. # noqa: E501

Return type

str

property edge_subnet_id

Gets the edge_subnet_id of this VpcInfo. # noqa: E501

Id of the NSX edge associated with this VPC (deprecated) # noqa: E501

Returns

The edge_subnet_id of this VpcInfo. # noqa: E501

Return type

str

property esx_public_security_group_id

Gets the esx_public_security_group_id of this VpcInfo. # noqa: E501

Returns

The esx_public_security_group_id of this VpcInfo. # noqa: E501

Return type

str

property esx_security_group_id

Gets the esx_security_group_id of this VpcInfo. # noqa: E501

Returns

The esx_security_group_id of this VpcInfo. # noqa: E501

Return type

str

property id

Gets the id of this VpcInfo. # noqa: E501

vpc id # noqa: E501

Returns

The id of this VpcInfo. # noqa: E501

Return type

str

property internet_gateway_id

Gets the internet_gateway_id of this VpcInfo. # noqa: E501

Returns

The internet_gateway_id of this VpcInfo. # noqa: E501

Return type

str

property network_type

Gets the network_type of this VpcInfo. # noqa: E501

Returns

The network_type of this VpcInfo. # noqa: E501

Return type

str

openapi_types = {'api_association_id': 'str', 'api_subnet_id': 'str', 'association_id': 'str', 'available_zones': 'list[AvailableZoneInfo]', 'edge_association_id': 'str', 'edge_subnet_id': 'str', 'esx_public_security_group_id': 'str', 'esx_security_group_id': 'str', 'id': 'str', 'internet_gateway_id': 'str', 'network_type': 'str', 'peering_connection_id': 'str', 'private_association_id': 'str', 'private_subnet_id': 'str', 'provider': 'str', 'route_table_id': 'str', 'routetables': 'dict(str, RouteTableInfo)', 'security_group_id': 'str', 'subnet_id': 'str', 'tgw_ips': 'dict(str, list[str])', 'vgw_id': 'str', 'vgw_route_table_id': 'str', 'vif_ids': 'list[str]', 'vm_security_group_id': 'str', 'vpc_cidr': 'str'}
property peering_connection_id

Gets the peering_connection_id of this VpcInfo. # noqa: E501

(deprecated) # noqa: E501

Returns

The peering_connection_id of this VpcInfo. # noqa: E501

Return type

str

property private_association_id

Gets the private_association_id of this VpcInfo. # noqa: E501

(deprecated) # noqa: E501

Returns

The private_association_id of this VpcInfo. # noqa: E501

Return type

str

property private_subnet_id

Gets the private_subnet_id of this VpcInfo. # noqa: E501

(deprecated) # noqa: E501

Returns

The private_subnet_id of this VpcInfo. # noqa: E501

Return type

str

property provider

Gets the provider of this VpcInfo. # noqa: E501

Returns

The provider of this VpcInfo. # noqa: E501

Return type

str

property route_table_id

Gets the route_table_id of this VpcInfo. # noqa: E501

(deprecated) # noqa: E501

Returns

The route_table_id of this VpcInfo. # noqa: E501

Return type

str

property routetables

Gets the routetables of this VpcInfo. # noqa: E501

map from routeTableName to routeTableInfo # noqa: E501

Returns

The routetables of this VpcInfo. # noqa: E501

Return type

dict(str, RouteTableInfo)

property security_group_id

Gets the security_group_id of this VpcInfo. # noqa: E501

Returns

The security_group_id of this VpcInfo. # noqa: E501

Return type

str

property subnet_id

Gets the subnet_id of this VpcInfo. # noqa: E501

(deprecated) # noqa: E501

Returns

The subnet_id of this VpcInfo. # noqa: E501

Return type

str

property tgw_ips

Gets the tgw_ips of this VpcInfo. # noqa: E501

Mapping from AZ to a list of IP addresses assigned to TGW ENI that’s connected with Vpc # noqa: E501

Returns

The tgw_ips of this VpcInfo. # noqa: E501

Return type

dict(str, list[str])

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vgw_id

Gets the vgw_id of this VpcInfo. # noqa: E501

Returns

The vgw_id of this VpcInfo. # noqa: E501

Return type

str

property vgw_route_table_id

Gets the vgw_route_table_id of this VpcInfo. # noqa: E501

Route table which contains the route to VGW (deprecated) # noqa: E501

Returns

The vgw_route_table_id of this VpcInfo. # noqa: E501

Return type

str

property vif_ids

Gets the vif_ids of this VpcInfo. # noqa: E501

set of virtual interfaces attached to the sddc # noqa: E501

Returns

The vif_ids of this VpcInfo. # noqa: E501

Return type

list[str]

property vm_security_group_id

Gets the vm_security_group_id of this VpcInfo. # noqa: E501

Returns

The vm_security_group_id of this VpcInfo. # noqa: E501

Return type

str

property vpc_cidr

Gets the vpc_cidr of this VpcInfo. # noqa: E501

Returns

The vpc_cidr of this VpcInfo. # noqa: E501

Return type

str

vmware.vmc.console.models.vpc_info_subnets module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vpc_info_subnets.VpcInfoSubnets(local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VpcInfoSubnets - a model defined in OpenAPI

attribute_map = {}
openapi_types = {}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.vpc_info_subnets_all_of module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vpc_info_subnets_all_of.VpcInfoSubnetsAllOf(vpc_id=None, cidr_block=None, description=None, subnets=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VpcInfoSubnetsAllOf - a model defined in OpenAPI

attribute_map = {'cidr_block': 'cidr_block', 'description': 'description', 'subnets': 'subnets', 'vpc_id': 'vpc_id'}
property cidr_block

Gets the cidr_block of this VpcInfoSubnetsAllOf. # noqa: E501

The overall CIDR block of the VPC. This is the AWS primary CIDR block. # noqa: E501

Returns

The cidr_block of this VpcInfoSubnetsAllOf. # noqa: E501

Return type

str

property description

Gets the description of this VpcInfoSubnetsAllOf. # noqa: E501

The description of the VPC; usually it’s name or id. # noqa: E501

Returns

The description of this VpcInfoSubnetsAllOf. # noqa: E501

Return type

str

openapi_types = {'cidr_block': 'str', 'description': 'str', 'subnets': 'list[SubnetInfo]', 'vpc_id': 'str'}
property subnets

Gets the subnets of this VpcInfoSubnetsAllOf. # noqa: E501

Returns

The subnets of this VpcInfoSubnetsAllOf. # noqa: E501

Return type

list[SubnetInfo]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property vpc_id

Gets the vpc_id of this VpcInfoSubnetsAllOf. # noqa: E501

The ID of the VPC these subnets belong to. # noqa: E501

Returns

The vpc_id of this VpcInfoSubnetsAllOf. # noqa: E501

Return type

str

vmware.vmc.console.models.vpn module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vpn.Vpn(version=None, on_prem_gateway_ip=None, on_prem_network_cidr=None, pfs_enabled=None, id=None, channel_status=None, on_prem_nat_ip=None, name=None, internal_network_ids=None, tunnel_statuses=None, encryption=None, enabled=None, state=None, dh_group=None, authentication=None, pre_shared_key=None, ike_option=None, digest_algorithm=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

Vpn - a model defined in OpenAPI

attribute_map = {'authentication': 'authentication', 'channel_status': 'channel_status', 'dh_group': 'dh_group', 'digest_algorithm': 'digest_algorithm', 'enabled': 'enabled', 'encryption': 'encryption', 'id': 'id', 'ike_option': 'ike_option', 'internal_network_ids': 'internal_network_ids', 'name': 'name', 'on_prem_gateway_ip': 'on_prem_gateway_ip', 'on_prem_nat_ip': 'on_prem_nat_ip', 'on_prem_network_cidr': 'on_prem_network_cidr', 'pfs_enabled': 'pfs_enabled', 'pre_shared_key': 'pre_shared_key', 'state': 'state', 'tunnel_statuses': 'tunnel_statuses', 'version': 'version'}
property authentication

Gets the authentication of this Vpn. # noqa: E501

Returns

The authentication of this Vpn. # noqa: E501

Return type

str

property channel_status

Gets the channel_status of this Vpn. # noqa: E501

Returns

The channel_status of this Vpn. # noqa: E501

Return type

VpnChannelStatus

property dh_group

Gets the dh_group of this Vpn. # noqa: E501

Returns

The dh_group of this Vpn. # noqa: E501

Return type

str

property digest_algorithm

Gets the digest_algorithm of this Vpn. # noqa: E501

Returns

The digest_algorithm of this Vpn. # noqa: E501

Return type

str

property enabled

Gets the enabled of this Vpn. # noqa: E501

Returns

The enabled of this Vpn. # noqa: E501

Return type

bool

property encryption

Gets the encryption of this Vpn. # noqa: E501

Returns

The encryption of this Vpn. # noqa: E501

Return type

str

property id

Gets the id of this Vpn. # noqa: E501

Returns

The id of this Vpn. # noqa: E501

Return type

str

property ike_option

Gets the ike_option of this Vpn. # noqa: E501

Returns

The ike_option of this Vpn. # noqa: E501

Return type

str

property internal_network_ids

Gets the internal_network_ids of this Vpn. # noqa: E501

Returns

The internal_network_ids of this Vpn. # noqa: E501

Return type

list[str]

property name

Gets the name of this Vpn. # noqa: E501

Returns

The name of this Vpn. # noqa: E501

Return type

str

property on_prem_gateway_ip

Gets the on_prem_gateway_ip of this Vpn. # noqa: E501

Returns

The on_prem_gateway_ip of this Vpn. # noqa: E501

Return type

str

property on_prem_nat_ip

Gets the on_prem_nat_ip of this Vpn. # noqa: E501

Returns

The on_prem_nat_ip of this Vpn. # noqa: E501

Return type

str

property on_prem_network_cidr

Gets the on_prem_network_cidr of this Vpn. # noqa: E501

Returns

The on_prem_network_cidr of this Vpn. # noqa: E501

Return type

str

openapi_types = {'authentication': 'str', 'channel_status': 'VpnChannelStatus', 'dh_group': 'str', 'digest_algorithm': 'str', 'enabled': 'bool', 'encryption': 'str', 'id': 'str', 'ike_option': 'str', 'internal_network_ids': 'list[str]', 'name': 'str', 'on_prem_gateway_ip': 'str', 'on_prem_nat_ip': 'str', 'on_prem_network_cidr': 'str', 'pfs_enabled': 'bool', 'pre_shared_key': 'str', 'state': 'str', 'tunnel_statuses': 'list[VpnTunnelStatus]', 'version': 'str'}
property pfs_enabled

Gets the pfs_enabled of this Vpn. # noqa: E501

Returns

The pfs_enabled of this Vpn. # noqa: E501

Return type

bool

property pre_shared_key

Gets the pre_shared_key of this Vpn. # noqa: E501

Returns

The pre_shared_key of this Vpn. # noqa: E501

Return type

str

property state

Gets the state of this Vpn. # noqa: E501

Returns

The state of this Vpn. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tunnel_statuses

Gets the tunnel_statuses of this Vpn. # noqa: E501

Returns

The tunnel_statuses of this Vpn. # noqa: E501

Return type

list[VpnTunnelStatus]

property version

Gets the version of this Vpn. # noqa: E501

Returns

The version of this Vpn. # noqa: E501

Return type

str

vmware.vmc.console.models.vpn_channel_status module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vpn_channel_status.VpnChannelStatus(channel_status=None, channel_state=None, last_info_message=None, failure_message=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VpnChannelStatus - a model defined in OpenAPI

attribute_map = {'channel_state': 'channel_state', 'channel_status': 'channel_status', 'failure_message': 'failure_message', 'last_info_message': 'last_info_message'}
property channel_state

Gets the channel_state of this VpnChannelStatus. # noqa: E501

Returns

The channel_state of this VpnChannelStatus. # noqa: E501

Return type

str

property channel_status

Gets the channel_status of this VpnChannelStatus. # noqa: E501

Returns

The channel_status of this VpnChannelStatus. # noqa: E501

Return type

str

property failure_message

Gets the failure_message of this VpnChannelStatus. # noqa: E501

Returns

The failure_message of this VpnChannelStatus. # noqa: E501

Return type

str

property last_info_message

Gets the last_info_message of this VpnChannelStatus. # noqa: E501

Returns

The last_info_message of this VpnChannelStatus. # noqa: E501

Return type

str

openapi_types = {'channel_state': 'str', 'channel_status': 'str', 'failure_message': 'str', 'last_info_message': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.vpn_tunnel_status module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vpn_tunnel_status.VpnTunnelStatus(on_prem_subnet=None, traffic_stats=None, last_info_message=None, local_subnet=None, tunnel_state=None, failure_message=None, tunnel_status=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VpnTunnelStatus - a model defined in OpenAPI

attribute_map = {'failure_message': 'failure_message', 'last_info_message': 'last_info_message', 'local_subnet': 'local_subnet', 'on_prem_subnet': 'on_prem_subnet', 'traffic_stats': 'traffic_stats', 'tunnel_state': 'tunnel_state', 'tunnel_status': 'tunnel_status'}
property failure_message

Gets the failure_message of this VpnTunnelStatus. # noqa: E501

Returns

The failure_message of this VpnTunnelStatus. # noqa: E501

Return type

str

property last_info_message

Gets the last_info_message of this VpnTunnelStatus. # noqa: E501

Returns

The last_info_message of this VpnTunnelStatus. # noqa: E501

Return type

str

property local_subnet

Gets the local_subnet of this VpnTunnelStatus. # noqa: E501

Returns

The local_subnet of this VpnTunnelStatus. # noqa: E501

Return type

str

property on_prem_subnet

Gets the on_prem_subnet of this VpnTunnelStatus. # noqa: E501

Returns

The on_prem_subnet of this VpnTunnelStatus. # noqa: E501

Return type

str

openapi_types = {'failure_message': 'str', 'last_info_message': 'str', 'local_subnet': 'str', 'on_prem_subnet': 'str', 'traffic_stats': 'VpnTunnelTrafficStats', 'tunnel_state': 'str', 'tunnel_status': 'str'}
to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property traffic_stats

Gets the traffic_stats of this VpnTunnelStatus. # noqa: E501

Returns

The traffic_stats of this VpnTunnelStatus. # noqa: E501

Return type

VpnTunnelTrafficStats

property tunnel_state

Gets the tunnel_state of this VpnTunnelStatus. # noqa: E501

Returns

The tunnel_state of this VpnTunnelStatus. # noqa: E501

Return type

str

property tunnel_status

Gets the tunnel_status of this VpnTunnelStatus. # noqa: E501

Returns

The tunnel_status of this VpnTunnelStatus. # noqa: E501

Return type

str

vmware.vmc.console.models.vpn_tunnel_traffic_stats module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vpn_tunnel_traffic_stats.VpnTunnelTrafficStats(packets_out=None, packet_received_errors=None, rx_bytes_on_local_subnet=None, replay_errors=None, sequence_number_over_flow_errors=None, encryption_failures=None, integrity_errors=None, packet_sent_errors=None, decryption_failures=None, packets_in=None, tx_bytes_from_local_subnet=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VpnTunnelTrafficStats - a model defined in OpenAPI

attribute_map = {'decryption_failures': 'decryption_failures', 'encryption_failures': 'encryption_failures', 'integrity_errors': 'integrity_errors', 'packet_received_errors': 'packet_received_errors', 'packet_sent_errors': 'packet_sent_errors', 'packets_in': 'packets_in', 'packets_out': 'packets_out', 'replay_errors': 'replay_errors', 'rx_bytes_on_local_subnet': 'rx_bytes_on_local_subnet', 'sequence_number_over_flow_errors': 'sequence_number_over_flow_errors', 'tx_bytes_from_local_subnet': 'tx_bytes_from_local_subnet'}
property decryption_failures

Gets the decryption_failures of this VpnTunnelTrafficStats. # noqa: E501

Returns

The decryption_failures of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

property encryption_failures

Gets the encryption_failures of this VpnTunnelTrafficStats. # noqa: E501

Returns

The encryption_failures of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

property integrity_errors

Gets the integrity_errors of this VpnTunnelTrafficStats. # noqa: E501

Returns

The integrity_errors of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

openapi_types = {'decryption_failures': 'str', 'encryption_failures': 'str', 'integrity_errors': 'str', 'packet_received_errors': 'str', 'packet_sent_errors': 'str', 'packets_in': 'str', 'packets_out': 'str', 'replay_errors': 'str', 'rx_bytes_on_local_subnet': 'str', 'sequence_number_over_flow_errors': 'str', 'tx_bytes_from_local_subnet': 'str'}
property packet_received_errors

Gets the packet_received_errors of this VpnTunnelTrafficStats. # noqa: E501

Returns

The packet_received_errors of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

property packet_sent_errors

Gets the packet_sent_errors of this VpnTunnelTrafficStats. # noqa: E501

Returns

The packet_sent_errors of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

property packets_in

Gets the packets_in of this VpnTunnelTrafficStats. # noqa: E501

Returns

The packets_in of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

property packets_out

Gets the packets_out of this VpnTunnelTrafficStats. # noqa: E501

Returns

The packets_out of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

property replay_errors

Gets the replay_errors of this VpnTunnelTrafficStats. # noqa: E501

Returns

The replay_errors of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

property rx_bytes_on_local_subnet

Gets the rx_bytes_on_local_subnet of this VpnTunnelTrafficStats. # noqa: E501

Returns

The rx_bytes_on_local_subnet of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

property sequence_number_over_flow_errors

Gets the sequence_number_over_flow_errors of this VpnTunnelTrafficStats. # noqa: E501

Returns

The sequence_number_over_flow_errors of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

property tx_bytes_from_local_subnet

Gets the tx_bytes_from_local_subnet of this VpnTunnelTrafficStats. # noqa: E501

Returns

The tx_bytes_from_local_subnet of this VpnTunnelTrafficStats. # noqa: E501

Return type

str

vmware.vmc.console.models.vsan_available_capacity module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vsan_available_capacity.VsanAvailableCapacity(cost=None, quality=None, size=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VsanAvailableCapacity - a model defined in OpenAPI

attribute_map = {'cost': 'cost', 'quality': 'quality', 'size': 'size'}
property cost

Gets the cost of this VsanAvailableCapacity. # noqa: E501

Returns

The cost of this VsanAvailableCapacity. # noqa: E501

Return type

str

openapi_types = {'cost': 'str', 'quality': 'str', 'size': 'int'}
property quality

Gets the quality of this VsanAvailableCapacity. # noqa: E501

Returns

The quality of this VsanAvailableCapacity. # noqa: E501

Return type

str

property size

Gets the size of this VsanAvailableCapacity. # noqa: E501

Returns

The size of this VsanAvailableCapacity. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.vsan_cluster_reconfig_bias module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vsan_cluster_reconfig_bias.VsanClusterReconfigBias(short_description=None, full_description=None, id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VsanClusterReconfigBias - a model defined in OpenAPI

attribute_map = {'full_description': 'full_description', 'id': 'id', 'short_description': 'short_description'}
property full_description

Gets the full_description of this VsanClusterReconfigBias. # noqa: E501

Returns

The full_description of this VsanClusterReconfigBias. # noqa: E501

Return type

str

property id

Gets the id of this VsanClusterReconfigBias. # noqa: E501

Returns

The id of this VsanClusterReconfigBias. # noqa: E501

Return type

str

openapi_types = {'full_description': 'str', 'id': 'str', 'short_description': 'str'}
property short_description

Gets the short_description of this VsanClusterReconfigBias. # noqa: E501

Returns

The short_description of this VsanClusterReconfigBias. # noqa: E501

Return type

str

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.vsan_cluster_reconfig_constraints module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vsan_cluster_reconfig_constraints.VsanClusterReconfigConstraints(reconfig_biases=None, available_capacities=None, default_capacities=None, hosts=None, default_reconfig_bias_id=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VsanClusterReconfigConstraints - a model defined in OpenAPI

attribute_map = {'available_capacities': 'available_capacities', 'default_capacities': 'default_capacities', 'default_reconfig_bias_id': 'default_reconfig_bias_id', 'hosts': 'hosts', 'reconfig_biases': 'reconfig_biases'}
property available_capacities

Gets the available_capacities of this VsanClusterReconfigConstraints. # noqa: E501

A map of VsanClusterReconfigBias id to the list of VsanAvailableCapacity. It gives all of available vSAN capacities for each of reconfiguration biases. # noqa: E501

Returns

The available_capacities of this VsanClusterReconfigConstraints. # noqa: E501

Return type

dict(str, list[VsanAvailableCapacity])

property default_capacities

Gets the default_capacities of this VsanClusterReconfigConstraints. # noqa: E501

A map of VsanClusterReconfigBias id to a VsanAvailableCapacity. It gives the default VsanAvailableCapacity for each of reconfiguration biases. # noqa: E501

Returns

The default_capacities of this VsanClusterReconfigConstraints. # noqa: E501

Return type

dict(str, VsanAvailableCapacity)

property default_reconfig_bias_id

Gets the default_reconfig_bias_id of this VsanClusterReconfigConstraints. # noqa: E501

The id of default VsanClusterReconfigBias for this constraints. # noqa: E501

Returns

The default_reconfig_bias_id of this VsanClusterReconfigConstraints. # noqa: E501

Return type

str

property hosts

Gets the hosts of this VsanClusterReconfigConstraints. # noqa: E501

The number of hosts in a cluster for the constraints. # noqa: E501

Returns

The hosts of this VsanClusterReconfigConstraints. # noqa: E501

Return type

int

openapi_types = {'available_capacities': 'dict(str, list[VsanAvailableCapacity])', 'default_capacities': 'dict(str, VsanAvailableCapacity)', 'default_reconfig_bias_id': 'str', 'hosts': 'int', 'reconfig_biases': 'list[VsanClusterReconfigBias]'}
property reconfig_biases

Gets the reconfig_biases of this VsanClusterReconfigConstraints. # noqa: E501

Biases to reconfigure vSAN in an existing cluster. # noqa: E501

Returns

The reconfig_biases of this VsanClusterReconfigConstraints. # noqa: E501

Return type

list[VsanClusterReconfigBias]

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.vsan_config_constraints module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vsan_config_constraints.VsanConfigConstraints(max_capacity=None, recommended_capacities=None, supported_capacity_increment=None, min_capacity=None, num_hosts=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VsanConfigConstraints - a model defined in OpenAPI

attribute_map = {'max_capacity': 'max_capacity', 'min_capacity': 'min_capacity', 'num_hosts': 'num_hosts', 'recommended_capacities': 'recommended_capacities', 'supported_capacity_increment': 'supported_capacity_increment'}
property max_capacity

Gets the max_capacity of this VsanConfigConstraints. # noqa: E501

Maximum capacity supported for cluster (GiB). # noqa: E501

Returns

The max_capacity of this VsanConfigConstraints. # noqa: E501

Return type

int

property min_capacity

Gets the min_capacity of this VsanConfigConstraints. # noqa: E501

Minimum capacity supported for cluster (GiB). # noqa: E501

Returns

The min_capacity of this VsanConfigConstraints. # noqa: E501

Return type

int

property num_hosts

Gets the num_hosts of this VsanConfigConstraints. # noqa: E501

Number of hosts in cluster. # noqa: E501

Returns

The num_hosts of this VsanConfigConstraints. # noqa: E501

Return type

int

openapi_types = {'max_capacity': 'int', 'min_capacity': 'int', 'num_hosts': 'int', 'recommended_capacities': 'list[int]', 'supported_capacity_increment': 'int'}
property recommended_capacities

Gets the recommended_capacities of this VsanConfigConstraints. # noqa: E501

List of supported capacities which may offer preferable performance (GiB). # noqa: E501

Returns

The recommended_capacities of this VsanConfigConstraints. # noqa: E501

Return type

list[int]

property supported_capacity_increment

Gets the supported_capacity_increment of this VsanConfigConstraints. # noqa: E501

Increment to be added to min_capacity to result in a supported capacity (GiB). # noqa: E501

Returns

The supported_capacity_increment of this VsanConfigConstraints. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

vmware.vmc.console.models.vsan_encryption_config module

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech

class vmware.vmc.console.models.vsan_encryption_config.VsanEncryptionConfig(port=None, certificate=None, local_vars_configuration=None)

Bases: object

NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech

Do not edit the class manually.

VsanEncryptionConfig - a model defined in OpenAPI

attribute_map = {'certificate': 'certificate', 'port': 'port'}
property certificate

Gets the certificate of this VsanEncryptionConfig. # noqa: E501

Public certificate used to connect to AWS Key Management Service # noqa: E501

Returns

The certificate of this VsanEncryptionConfig. # noqa: E501

Return type

str

openapi_types = {'certificate': 'str', 'port': 'int'}
property port

Gets the port of this VsanEncryptionConfig. # noqa: E501

Port to connect to AWS Key Management Service # noqa: E501

Returns

The port of this VsanEncryptionConfig. # noqa: E501

Return type

int

to_dict()

Returns the model properties as a dict

to_str()

Returns the string representation of the model

Module contents

VMware Cloud APIs

The version of the OpenAPI document: 1.0 Generated by: https://openapi-generator.tech