com.vmware.vcenter.namespace_management.supervisors.networks package

Submodules

com.vmware.vcenter.namespace_management.supervisors.networks.management_client module

The com.vmware.vcenter.namespace_management.supervisors.networks.management_client module provides classes for Supervisor management network configuration.

class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.Network(network=None, backing=None, services=None, ip_management=None, floating_ip_address=None, proxy=None)

Bases: VapiStruct

Network class represents configuration for a network used to manage the Supervisor control plane. vCenter and, if used, NSX Manager and/or external Load Balancers, etc. should be reachable on this network.. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

  • network (str or None) – Network.network is a unique identifier for this network which can be referenced later for updates or queries.. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network. If unset, an ID will be generated.

  • backing (NetworkBacking) – Network.backing specifies the network backing to use as the uplink to the management network.. This attribute was added in vSphere API 8.0.0.1.

  • services (com.vmware.vcenter.namespace_management.networks_client.Services or None) – Network.services specifies which network services are configured on this network. These network services are expected to be accessible via the associated distributed virtual port group or distributed virtual switch.. This attribute was added in vSphere API 8.0.0.1. If unset, network services may be automatically configured. If you want to disable any configuration of network services, explicitly set this class to empty.

  • ip_management (com.vmware.vcenter.namespace_management.networks_client.IPManagement or None) – Network.ip_management describes how IP addressing is configured on this network.. This attribute was added in vSphere API 8.0.0.1. If unset, this network becomes a DHCP network. Your DHCP server must support client identifiers to successfully enable a Supervisor.

  • floating_ip_address (str or None) – Network.floating_ip_address is an IP address that provides a stable endpoint to the control plane. This address if specified must be an unused statically allocated IP address on the management network.. This attribute was added in vSphere API 8.0.0.1. If None and the management network is a static network, this address should be allocated in a static IP configuration which occurs when com.vmware.vcenter.namespace_management.networks_client.IPManagement.dhcp_enabled is set to false. If None and the management network is a DHCP network, The Supervisor will attempt to use the DHCP server to allocate this address. You should ensure the DHCP server is configured to persist IP addresses indefinitely using client identifiers if this configuration is used.

  • proxy (ProxyConfiguration or None) – Proxy configuration will be applied to the Supervisor. The proxy should be reachable from the management network and will be used for image pulling and container traffic exiting out of the Supervisor.. This attribute was added in vSphere API 8.0.0.1. If None the settings will be inherited from the vCenter settings if available.

class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBacking(backing=None, network=None, network_segment=None)

Bases: VapiStruct

A NetworkBacking enumerates the possible options for uplinking to a Supervisor management network. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

  • backing (NetworkBackingEnum) – Selects the backing used for a management network. This attribute was added in vSphere API 8.0.0.1.

  • network (str) – The Managed Object ID of the Network object. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: Network. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: Network. This attribute is optional and it is only relevant when the value of backing is NetworkBackingEnum.NETWORK.

  • network_segment (com.vmware.vcenter.namespace_management.supervisors.networks_client.NetworkSegment) – The Backing Network Segment. This attribute was added in vSphere API 8.0.3.0. This attribute is optional and it is only relevant when the value of backing is NetworkBackingEnum.NETWORK_SEGMENT.

class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.NetworkBackingEnum(string)

Bases: Enum

NetworkBackingEnum enumerates types of network backings supported by the Supervisor for the management network. This enumeration was added in vSphere API 8.0.0.1.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:

string (str) – String value for the NetworkBackingEnum instance.

NETWORK = NetworkBackingEnum(string='NETWORK')

Indicates a virtual infrastructure management Network. It may include items like opaque networks or Distributed Virtual Port Groups. This field is deprecated, use NetworkBackingEnum.NETWORK_SEGMENT instead.. This class attribute was added in vSphere API 8.0.0.1.

Deprecated since version vSphere: API 8.0.3.0

NETWORK_SEGMENT = NetworkBackingEnum(string='NETWORK_SEGMENT')

Indicates a virtual infrastructure management Network Segment. The Network Segment can be backed by either a single Port Group or a set of Port Groups in the same layer 2 broadcast domain. From this set of one or more Port Groups, at least one Port Group must be available on each vSphere Zone and its associated vSphere clusters that Supervisor control plane is configured to be enabled on. This class attribute was added in vSphere API 8.0.3.0.

class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxyConfiguration(proxy_settings_source=None, https_proxy_config=None, http_proxy_config=None, no_proxy_config=None, tls_root_ca_bundle=None)

Bases: VapiStruct

The ProxyConfiguration class defines proxy configuration to be used by the Supervisor.. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

  • proxy_settings_source (ProxySettingsSource) –

    The source of the proxy settings.

    If ProxySettingsSource.VC_INHERITED or ProxySettingsSource.NONE is specified, then the other configuration in ProxyConfiguration will be ignored.. This attribute was added in vSphere API 8.0.0.1.

  • https_proxy_config (str or None) –

    HTTPS proxy configuration. Examples:

    This will be used if ProxySettingsSource.CLUSTER_CONFIGURED is used for the source, otherwise this will be ignored.. This attribute was added in vSphere API 8.0.0.1. If None no HTTPS proxy will be used.

  • http_proxy_config (str or None) –

    HTTP proxy configuration. Examples:

    This will be used if ProxySettingsSource.CLUSTER_CONFIGURED is used for the source, otherwise this will be ignored.. This attribute was added in vSphere API 8.0.0.1. If None no HTTP proxy will be used.

  • no_proxy_config (list of str or None) –

    List of addresses that should be accessed directly.

    This will be used if ProxySettingsSource.CLUSTER_CONFIGURED is used for the source, otherwise this will be ignored.. This attribute was added in vSphere API 8.0.0.1. If None there won’t be any excluded addresses.

  • tls_root_ca_bundle (str or None) –

    Proxy TLS root CA bundle which will be used to verify the proxy’s certificates. Every certificate in the bundle is expected to be in PEM format.

    This will be used if ProxySettingsSource.CLUSTER_CONFIGURED is used for the source, otherwise this will be ignored.. This attribute was added in vSphere API 8.0.0.1. If None only the vCenter certificates applied in VECS (VMware Endpoint Certificate Store) will be used.

class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.ProxySettingsSource(string)

Bases: Enum

The settings can be inherited from the vCenter settings, so the Supervisor settings will be synced. The settings can be applied directly on the Supervisor level, or the Supervisor can be configured not to use a proxy.. This enumeration was added in vSphere API 8.0.0.1.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:

string (str) – String value for the ProxySettingsSource instance.

CLUSTER_CONFIGURED = ProxySettingsSource(string='CLUSTER_CONFIGURED')

Proxy settings will be configured at the Supervisor level. This class attribute was added in vSphere API 8.0.0.1.

NONE = ProxySettingsSource(string='NONE')

No proxy settings will be applied to the Supervisor. This class attribute was added in vSphere API 8.0.0.1.

VC_INHERITED = ProxySettingsSource(string='VC_INHERITED')

Proxy settings will be inherited from the vCenter settings. vCenter and Supervisor settings will be kept in sync.. This class attribute was added in vSphere API 8.0.0.1.

class com.vmware.vcenter.namespace_management.supervisors.networks.management_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

com.vmware.vcenter.namespace_management.supervisors.networks.workload_client module

The com.vmware.vcenter.namespace_management.supervisors.networks.workload_client module provides classes to configure workload network of a Supervisor.

class com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.Network(network=None, network_type=None, nsx=None, vsphere=None, services=None, ip_management=None)

Bases: VapiStruct

Network class represents configuration for a network running workloads on a Supervisor.. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

  • network (str or None) – Network.network is a unique identifier for this network which can be referenced later for updates or queries.. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.namespace_management.Network. If unset, an ID will be generated.

  • network_type (NetworkType) – Network.network_type describes the type of network.. This attribute was added in vSphere API 8.0.0.1.

  • nsx (NsxNetwork) – Network.nsx specifies network configuration that is specific to NSX-T networks.. This attribute was added in vSphere API 8.0.0.1. This attribute is optional and it is only relevant when the value of networkType is NetworkType.NSXT.

  • vsphere (VSphereNetwork) – Network.vsphere specifies network configuration that is specific to vSphere networks.. This attribute was added in vSphere API 8.0.0.1. This attribute is optional and it is only relevant when the value of networkType is NetworkType.VSPHERE.

  • services (com.vmware.vcenter.namespace_management.networks_client.Services or None) – Network.services specifies which network services are configured on this network. These network services are expected to be accessible via the associated distributed virtual port group or distributed virtual switch.. This attribute was added in vSphere API 8.0.0.1. If unset, network services may be automatically configured. If you want to disable any configuration of network services, explicitly set this class to empty.

  • ip_management (com.vmware.vcenter.namespace_management.networks_client.IPManagement or None) – Network.ip_management describes how IP addressing is configured on this network.. This attribute was added in vSphere API 8.0.0.1. If unset, this network becomes a DHCP network. Your DHCP server must support client identifiers to successfully enable a Supervisor.

class com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NetworkType(string)

Bases: Enum

NetworkType enumerates types of networks supported by the Supervisor for workloads.. This enumeration was added in vSphere API 8.0.0.1.

Note

This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.

Parameters:

string (str) – String value for the NetworkType instance.

NSXT = NetworkType(string='NSXT')

Indicates an NSX-T backed network.. This class attribute was added in vSphere API 8.0.0.1.

VSPHERE = NetworkType(string='VSPHERE')

Indicates vSphere Networking.. This class attribute was added in vSphere API 8.0.0.1.

class com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.NsxNetwork(dvs=None, namespace_subnet_prefix=None)

Bases: VapiStruct

NsxNetwork specifies network backing configuration that is specific to the workload network.. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

  • dvs (str) – NsxNetwork.dvs is the Managed Object ID of a vSphere Distributed Virtual Switch. You can use it to connect to an NSX-T Network.. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: vSphereDistributedSwitch. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: vSphereDistributedSwitch.

  • namespace_subnet_prefix (long or None) – NsxNetwork.namespace_subnet_prefix indicates the size of the subnet reserved for namespace segments.. This attribute was added in vSphere API 8.0.0.1. Defaults to /28.

class com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.vcenter.namespace_management.supervisors.networks.workload_client.VSphereNetwork(dvpg=None)

Bases: VapiStruct

VSphereNetwork specifies workload network configuration that is specific to vSphere networks.. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

dvpg (str) – VSphereNetwork.dvpg is the Managed Object ID of a vSphere Distributed Virtual Port Group. You can use it to connect to a vSphere Network.. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: vSphereDistributedPortGroup. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: vSphereDistributedPortGroup.